Partager via


Tenant Configuration - Save

Cette opération crée un commit avec la configuration actuelle instantané à la branche spécifiée dans le dépôt. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2021-08-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

Nom du groupe de ressources.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
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 du client.

Corps de la demande

Nom Obligatoire Type Description
properties.branch True

string

Nom de la branche Git dans laquelle valider la configuration actuelle instantané.

properties.force

boolean

Valeur si la valeur est true, la base de données de configuration actuelle est validée dans le référentiel Git, même si le dépôt 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’un commit dans le dépôt.

202 Accepted

Accepté : l’en-tête Emplacement contient l’URL où les status de l’opération de longue durée peuvent être vérifiées.

Other Status Codes

ErrorResponse

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

ApiManagementTenantConfigurationSave

Exemple de requête

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

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

Exemple de réponse

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2021-08-01
{
  "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.

ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

ErrorResponseBody

Contrat du corps de l’erreur.

OperationResultContract

Résultats des opérations Git de longue durée.

OperationResultLogItemContract

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

SaveConfigurationParameter

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

AsyncOperationStatus

État d’une opération asynchrone.

Nom Type Description
Failed

string

InProgress

string

Started

string

Succeeded

string

configurationIdName

Identificateur de l’opération de configuration Git.

Nom Type Description
configuration

string

ErrorFieldContract

Contrat de 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 des propriétés.

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

ErrorFieldContract[]

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.

ErrorResponseBody

Contrat du corps de l’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 contrôlable de visu de l’erreur.

OperationResultContract

Résultats des opérations 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é est fournie 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 du corps d’erreur

properties.id

string

Identificateur du résultat de l’opération.

properties.resultInfo

string

Informations de résultat facultatives.

properties.started

string

Heure de début d’une opération asynchrone. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

properties.status

AsyncOperationStatus

État d’une opération asynchrone.

properties.updated

string

Heure de la dernière mise à jour d’une opération asynchrone. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

OperationResultLogItemContract

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

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/suppression.

objectType

string

Type de contrat d’entité.

SaveConfigurationParameter

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

Nom Type Description
properties.branch

string

Nom de la branche Git dans laquelle valider la configuration actuelle instantané.

properties.force

boolean

Valeur si la valeur est true, la base de données de configuration actuelle est validée dans le référentiel Git, même si le dépôt Git a des modifications plus récentes qui seraient remplacées.