Tenant Configuration - Get Sync State
Obtient la status de la synchronisation la plus récente entre la base de données de configuration et le dépôt Git.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState?api-version=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
configuration
|
path | True |
Identificateur de l’opération de configuration Git. |
|
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande cliente. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Résultat de l’état de synchronisation. |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
ApiManagementTenantAccessSyncState
Exemple de requête
Exemple de réponse
{
"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"
}
}
Définitions
Nom | Description |
---|---|
configuration |
Identificateur de l’opération de configuration Git. |
Error |
Contrat champ d’erreur. |
Error |
Réponse d’erreur. |
Tenant |
Résultat de l’état de synchronisation de la configuration du locataire. |
configurationIdName
Identificateur de l’opération de configuration Git.
Nom | Type | Description |
---|---|---|
configuration |
string |
ErrorFieldContract
Contrat champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur de niveau propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau de la propriété. |
target |
string |
Nom de propriété. |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error.code |
string |
Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse. |
error.details |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation contrôlable de visu de l’erreur. |
TenantConfigurationSyncStateContract
Résultat de l’état de synchronisation de la configuration du locataire.
Nom | Type | Description |
---|---|---|
id |
string |
ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nom de la ressource. |
properties.branch |
string |
Nom de la branche Git. |
properties.commitId |
string |
ID de validation le plus récent. |
properties.configurationChangeDate |
string |
Date de la dernière modification de configuration. La date est conforme au format suivant : |
properties.isExport |
boolean |
valeur indiquant si la dernière opération de synchronisation a été enregistrée (true) ou déployée (false). |
properties.isGitEnabled |
boolean |
valeur indiquant si l’accès à la configuration Git est activé. |
properties.isSynced |
boolean |
valeur indiquant si la dernière synchronisation a été postérieure à la modification de configuration. |
properties.lastOperationId |
string |
Identificateur d’opération de configuration de locataire le plus récent |
properties.syncDate |
string |
Date de la dernière synchronisation. La date est conforme au format suivant : |
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |