Tenant Configuration - 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.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

configurationName
path True

The identifier of the Git Configuration Operation.

api-version
query True
  • string

Version of the API to be used with the client request.

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

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.

Other Status Codes

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/deploy?api-version=2019-01-01
{
  "properties": {
    "branch": "master"
  }
}

Sample Response

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af4ae2a6d2e0b688d7517?api-version=2019-01-01
{
  "id": "5a1af4ae2a6d2e0b688d7517",
  "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

AsyncOperationStatus

Status of an async operation.

configurationIdName

The identifier of the Git Configuration Operation.

DeployConfigurationParameters

Deploy Tenant Configuration Contract.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

ErrorResponseBody

Error Body contract.

OperationResultContract

Operation Result.

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.

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.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

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

The list of invalid fields send in request, in case of validation error.

message
  • string

Human-readable representation of the error.

OperationResultContract

Operation Result.

Name Type Description
actionLog

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.

error

Error Body Contract

id
  • string

Operation result identifier.

resultInfo
  • string

Optional result info.

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.

status

Status of an async operation.

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.

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.