APIHub
Back to Explore

ApiManagementClient

Use these REST APIs for performing operations on tenant entity associated with your Azure API Management deployment. Using this entity you can manage properties and configuration that apply to the entire API Management service instance.

Cloud
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}

Get tenant access information details

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}

Tenant access metadata

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}

Update tenant access information details.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • accessName (path, required) — The identifier of the Access configuration.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git

Gets the Git access configuration for the tenant.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regeneratePrimaryKey

Regenerate primary access key for GIT.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/git/regenerateSecondaryKey

Regenerate secondary access key for GIT.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regeneratePrimaryKey

Regenerate primary access key

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/regenerateSecondaryKey

Regenerate secondary access key

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • accessName (path, required) — The identifier of the Access configuration.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/deploy

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName (path, required) — The identifier of the Git Configuration Operation.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/save

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName (path, required) — The identifier of the Git Configuration Operation.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/syncState

Gets the status of the most recent synchronization between the configuration database and the Git repository.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName (path, required) — The identifier of the Git Configuration Operation.
POST

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{configurationName}/validate

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • configurationName (path, required) — The identifier of the Git Configuration Operation.

12 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}"

management.azure.com · HTTPS only