Tenant Configuration - Get Sync State
Возвращает состояние последней синхронизации между базой данных конфигурации и репозиторием Git.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
configuration
|
path | True |
Идентификатор операции конфигурации Git. |
|
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Regex pattern: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Результат состояния синхронизации. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementTenantAccessSyncState
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState?api-version=2022-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"
}
}
Определения
Имя | Описание |
---|---|
configuration |
Идентификатор операции конфигурации Git. |
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
Tenant |
Результат состояния синхронизации конфигурации клиента. |
configurationIdName
Идентификатор операции конфигурации Git.
Имя | Тип | Описание |
---|---|---|
configuration |
string |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
TenantConfigurationSyncStateContract
Результат состояния синхронизации конфигурации клиента.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.branch |
string |
Имя ветви Git. |
properties.commitId |
string |
Идентификатор последней фиксации. |
properties.configurationChangeDate |
string |
Дата последнего изменения конфигурации. Дата соответствует следующему формату: |
properties.isExport |
boolean |
значение, указывающее, была ли последняя синхронизация операцией сохранения (true) или операции развертывания (false). |
properties.isGitEnabled |
boolean |
значение, указывающее, включен ли доступ к конфигурации Git. |
properties.isSynced |
boolean |
значение, указывающее, была ли последняя синхронизация позже изменения конфигурации. |
properties.lastOperationId |
string |
Идентификатор последней операции конфигурации клиента |
properties.syncDate |
string |
Дата последней синхронизации. Дата соответствует следующему формату: |
type |
string |
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts. |