你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Tenant Configuration - Deploy

Service:

API Management

API Version:

2024-05-01

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.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/deploy?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
configurationName	path	True	configurationIdName	The identifier of the Git Configuration Operation.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
properties.branch	True	string	The name of the Git branch from which the configuration is to be deployed to the configuration database.
properties.force		boolean	The value enforcing deleting subscriptions to products that are deleted in this update.

Responses

Name	Type	Description
200 OK	OperationResultContract	Result of applying changes from Git branch to database.
202 Accepted		Accepted: Location header contains the URL where the status of the long running operation can be checked. Headers location: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementTenantConfigurationDeploy

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/deploy?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

Sample response

Status code:

202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2024-05-01

Status code:

200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Failed",
    "started": "2017-11-26T17:06:54.303Z",
    "updated": "2017-11-26T17:07:21.777Z",
    "error": {
      "code": "ValidationError",
      "message": "File not found: 'api-management/configuration.json'"
    }
  }
}

Definitions

Name	Description
AsyncOperationStatus	Status of an async operation.
configurationIdName	The identifier of the Git Configuration Operation.
DeployConfigurationParameters	Deploy Tenant Configuration Contract.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorFieldContract	Error Field contract.
ErrorResponse	Error response
ErrorResponseBody	Error Body contract.
OperationResultContract	Long Running Git Operation Results.
OperationResultLogItemContract	Log of the entity being created, updated or deleted.

AsyncOperationStatus

Status of an async operation.

Name	Type	Description
Failed	string
InProgress	string
Started	string
Succeeded	string

configurationIdName

The identifier of the Git Configuration Operation.

Name	Type	Description
configuration	string

DeployConfigurationParameters

Deploy Tenant Configuration Contract.

Name	Type	Description
properties.branch	string	The name of the Git branch from which the configuration is to be deployed to the configuration database.
properties.force	boolean	The value enforcing deleting subscriptions to products that are deleted in this update.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ErrorResponseBody

Error Body contract.

Name	Type	Description
code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
message	string	Human-readable representation of the error.

OperationResultContract

Long Running Git Operation Results.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.actionLog	OperationResultLogItemContract[]	This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.
properties.error	ErrorResponseBody	Error Body Contract
properties.id	string	Operation result identifier.
properties.resultInfo	string	Optional result info.
properties.started	string	Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
properties.status	AsyncOperationStatus	Status of an async operation.
properties.updated	string	Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Log of the entity being created, updated or deleted.

Name	Type	Description
action	string	Action like create/update/delete.
objectKey	string	Identifier of the entity being created/updated/deleted.
objectType	string	The type of entity contract.