Tenant Configuration - Save

Référence

Service:: API Management

Version d'API:: 2024-05-01

Cette opération crée une validation avec l’instantané de configuration actuel sur la branche spécifiée dans le référentiel. Il s’agit d’une opération longue et peut prendre plusieurs minutes.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configurationName	path	True	configurationIdName	Identificateur de l’opération de configuration Git.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.branch	True	string	Nom de la branche Git dans laquelle valider l’instantané de configuration actuel.
properties.force		boolean	La valeur si true, la base de données de configuration actuelle est validée dans le référentiel Git, même si le référentiel Git a des modifications plus récentes qui seraient remplacées.

Réponses

Nom	Type	Description
200 OK	OperationResultContract	Résultat de la création d’une validation dans le référentiel.
202 Accepted		Accepté : l’en-tête Location contient l’URL dans laquelle l’état de l’opération de longue durée peut être vérifié. En-têtes location: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

OperationResultContract

Résultat de la création d’une validation dans le référentiel.

202 Accepted

Accepté : l’en-tête Location contient l’URL dans laquelle l’état de l’opération de longue durée peut être vérifié.

En-têtes

location: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementTenantConfigurationSave

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/save?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

Exemple de réponse

Code d’état:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-05-01

Code d’état:: 200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Succeeded",
    "started": "2021-04-13T00:31:14.94Z",
    "updated": "2021-04-13T00:31:27.59Z",
    "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.",
    "actionLog": []
  }
}

Définitions

Nom	Description
AsyncOperationStatus	État d’une opération asynchrone.
configurationIdName	Identificateur de l’opération de configuration Git.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur
ErrorResponseBody	Contrat de corps d’erreur.
OperationResultContract	Résultats de l’opération Git de longue durée.
OperationResultLogItemContract	Journal de l’entité en cours de création, mise à jour ou supprimée.
SaveConfigurationParameter	Enregistrez les détails du contrat de configuration du locataire.

AsyncOperationStatus

Énumération

État d’une opération asynchrone.

Valeur	Description
Failed
InProgress
Started
Succeeded

configurationIdName

Énumération

Identificateur de l’opération de configuration Git.

Valeur	Description
configuration

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorFieldContract

Object

Contrat de champ d’erreur.

Nom	Type	Description
code	string	Code d’erreur au niveau de la propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target	string	Nom de la propriété.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ErrorResponseBody

Object

Contrat de corps d’erreur.

Nom	Type	Description
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.
details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
message	string	Représentation lisible par l’homme de l’erreur.

OperationResultContract

Object

Résultats de l’opération Git de longue durée.

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.actionLog	OperationResultLogItemContract[]	Cette propriété s’il est fourni uniquement dans le cadre de l’opération de TenantConfiguration_Validate. Il contient le journal des entités qui seront mises à jour/créées/supprimées dans le cadre de l’opération de TenantConfiguration_Deploy.
properties.error	ErrorResponseBody	Contrat de corps d’erreur
properties.id	string	Identificateur de résultat de l’opération.
properties.resultInfo	string	Informations de résultat facultatives.
properties.started	string (date-time)	Heure de début d’une opération asynchrone. La date est conforme au format suivant : `yyyy-MM-ddTHH:mm:ssZ` comme spécifié par la norme ISO 8601.
properties.status	AsyncOperationStatus	État d’une opération asynchrone.
properties.updated	string (date-time)	Heure de la dernière mise à jour d’une opération asynchrone. La date est conforme au format suivant : `yyyy-MM-ddTHH:mm:ssZ` comme spécifié par la norme ISO 8601.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OperationResultLogItemContract

Object

Journal de l’entité en cours de création, mise à jour ou supprimée.

Nom	Type	Description
action	string	Action telle que créer/mettre à jour/supprimer.
objectKey	string	Identificateur de l’entité en cours de création/mise à jour/supprimée.
objectType	string	Type de contrat d’entité.

SaveConfigurationParameter

Object

Enregistrez les détails du contrat de configuration du locataire.

Nom	Type	Description
properties.branch	string	Nom de la branche Git dans laquelle valider l’instantané de configuration actuel.
properties.force	boolean	La valeur si true, la base de données de configuration actuelle est validée dans le référentiel Git, même si le référentiel Git a des modifications plus récentes qui seraient remplacées.

Partager via

Tenant Configuration - Save

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementTenantConfigurationSave

Exemple de requête

Exemple de réponse

Définitions

AsyncOperationStatus

configurationIdName

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

SaveConfigurationParameter

Ressources supplémentaires