Tenant Configuration - Get Sync State

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState?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.

Responses

Name Type Description
200 OK

Sync state result.

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

ApiManagementTenantAccessSyncState

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState?api-version=2019-01-01

Sample Response

{
  "branch": "master",
  "commitId": "44c29c27a876372e2ea18d9c381cc493a6a89fc5",
  "isExport": true,
  "isSynced": false,
  "isGitEnabled": true,
  "syncDate": "2016-10-24T19:17:14.3641403Z",
  "configurationChangeDate": "2017-06-03T00:41:30.9670873Z"
}

Definitions

configurationIdName

The identifier of the Git Configuration Operation.

TenantConfigurationSyncStateContract

Tenant Configuration Synchronization State.

configurationIdName

The identifier of the Git Configuration Operation.

Name Type Description
configuration
  • string

TenantConfigurationSyncStateContract

Tenant Configuration Synchronization State.

Name Type Description
branch
  • string

The name of Git branch.

commitId
  • string

The latest commit Id.

configurationChangeDate
  • string

The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

isExport
  • boolean

value indicating if last sync was save (true) or deploy (false) operation.

isGitEnabled
  • boolean

value indicating whether Git configuration access is enabled.

isSynced
  • boolean

value indicating if last synchronization was later than the configuration change.

syncDate
  • string

The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.