Tenant Configuration - Get Sync State
Hämtar status för den senaste synkroniseringen mellan konfigurationsdatabasen och Git-lagringsplatsen.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState?api-version=2022-08-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
configuration
|
path | True |
Identifieraren för Git-konfigurationsåtgärden. |
|
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Regex pattern: |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Resultat av synkroniseringstillstånd. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
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 | personifiera ditt användarkonto |
Exempel
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"
}
}
Definitioner
Name | Description |
---|---|
configuration |
Identifieraren för Git-konfigurationsåtgärden. |
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Tenant |
Resultatet av synkroniseringstillståndet för klientkonfigurationen. |
configurationIdName
Identifieraren för Git-konfigurationsåtgärden.
Name | Typ | Description |
---|---|---|
configuration |
string |
ErrorFieldContract
Fel fältkontrakt.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod på egenskapsnivå. |
message |
string |
Mänsklig läsbar representation av fel på egenskapsnivå. |
target |
string |
Egenskapsnamn. |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
error.code |
string |
Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret. |
error.details |
Listan över ogiltiga fält som skickas i begäran, vid valideringsfel. |
|
error.message |
string |
Mänsklig läsbar representation av felet. |
TenantConfigurationSyncStateContract
Resultatet av synkroniseringstillståndet för klientkonfigurationen.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.branch |
string |
Namnet på Git-grenen. |
properties.commitId |
string |
Det senaste inchecknings-ID:t. |
properties.configurationChangeDate |
string |
Datumet för den senaste konfigurationsändringen. Datumet överensstämmer med följande format: |
properties.isExport |
boolean |
värde som anger om den senaste synkroniseringen sparades (sant) eller om åtgärden distribuerades (falskt). |
properties.isGitEnabled |
boolean |
värde som anger om Git-konfigurationsåtkomst är aktiverat. |
properties.isSynced |
boolean |
värde som anger om den senaste synkroniseringen var senare än konfigurationsändringen. |
properties.lastOperationId |
string |
Senaste identifierare för klientkonfigurationsåtgärd |
properties.syncDate |
string |
Datumet för den senaste synkroniseringen. Datumet överensstämmer med följande format: |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |