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=2021-08-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.

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

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

api-version
query True

string

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

Responses

Name Type Description
200 OK

TenantConfigurationSyncStateContract

Sync state result.

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

ApiManagementTenantAccessSyncState

Sample request

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

Sample response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState",
  "type": "Microsoft.ApiManagement/service/tenant/syncState",
  "name": "syncState",
  "properties": {
    "branch": "master",
    "commitId": "de891c2342c7058dde45e5e624eae7e558c94683",
    "isExport": true,
    "isSynced": true,
    "isGitEnabled": true,
    "syncDate": "2021-04-13T01:15:53.9824995Z",
    "configurationChangeDate": "2021-04-13T00:11:43.862781Z",
    "lastOperationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347"
  }
}

Definitions

Name Description
configurationIdName

The identifier of the Git Configuration Operation.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

TenantConfigurationSyncStateContract

Result of Tenant Configuration Sync State.

configurationIdName

The identifier of the Git Configuration Operation.

Name Type Description
configuration

string

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

ErrorFieldContract[]

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

error.message

string

Human-readable representation of the error.

TenantConfigurationSyncStateContract

Result of Tenant Configuration Sync State.

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.branch

string

The name of Git branch.

properties.commitId

string

The latest commit Id.

properties.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.

properties.isExport

boolean

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

properties.isGitEnabled

boolean

value indicating whether Git configuration access is enabled.

properties.isSynced

boolean

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

properties.lastOperationId

string

Most recent tenant configuration operation identifier

properties.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.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"