Modification de la configuration d'un déploiement

Article
08/05/2023

L'opération Change Deployment Configuration asynchrone modifie la configuration d'un déploiement.

Requête

La demande Change Deployment Configuration peut être spécifiée comme suit. Remplacez <subscription-id> par votre ID d'abonnement, <cloudservice-name> par le nom du service cloud, <deployment-slot> par staging ou production, ou <deployment-name> par le nom unique de votre déploiement.

Méthode	URI de demande
POST	`https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deploymentslots/<deployment-slot>/`
POST	`https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/`

Paramètres URI

Paramètre d’URI	Description
`comp=config`	Obligatoire. Spécifie qu'une modification doit être apportée à la configuration du déploiement.

En-têtes de requête

Le tableau suivant décrit les en-têtes de la demande.

En-tête de requête	Description
`Content-Type`	Obligatoire. Définissez cet en-tête sur la valeur `application/xml`.
`x-ms-version`	Obligatoire. Spécifie la version de l'opération à utiliser pour cette demande. Cet en-tête doit être défini sur `2009-10-01` ou une valeur supérieure.

Corps de la requête

Le corps de la demande présente le format suivant :

  
<?xml version="1.0" encoding="utf-8"?>  
<ChangeConfiguration xmlns="http://schemas.microsoft.com/windowsazure">  
  <Configuration>base-64-encoded-configuration-file</Configuration>  
  <TreatWarningsAsError>warnings-as-errors</TreatWarningsAsError>  
  <Mode>type-of-change</Mode>  
  <ExtendedProperties>  
    <ExtendedProperty>  
      <Name>property-name</Name>  
      <Value>property-value</Value>  
    </ExtendedProperty>  
  </ExtendedProperties>  
  <ExtensionConfiguration>  
    <AllRoles>  
      <Extension>  
        <Id>identifier-of-extension</Id>  
        <State>state-of-extension</State>  
      </Extension>  
    </AllRoles>  
    <NamedRoles>  
      <Role>  
        <RoleName>role_name1</RoleName>  
        <Extensions>  
          <Extension>  
            <Id>identifier-of-extension</Id>  
            <State>state-of-extension</State>  
          </Extension>  
        </Extensions>  
      </Role>  
    </NamedRoles>  
  </ExtensionConfiguration>  
</ChangeConfiguration>

Le tableau suivant décrit les éléments du corps de la demande.

Nom de l'élément	Description
Configuration	Obligatoire. Spécifie le fichier de configuration du service codé en base 64 pour le déploiement.
TreatWarningsAsError	Optionnel. Indique si les avertissements doivent être traités comme des erreurs. Les valeurs possibles sont les suivantes : - `true` - `false` Si elle n’est pas spécifiée, la valeur par défaut est `false`. Si défini sur `true`, la mise à jour est bloquée lorsque des avertissements apparaissent. L’élément `TreatWarningsAsError` est disponible uniquement à l’aide de la version 2011-04-01 ou ultérieure.
Mode	facultatif. Les valeurs possibles sont les suivantes : - `Auto` - `Manual` - `Simultaneous` En l'absence de spécification, la valeur par défaut est `Auto`. Si la valeur est `Manual`définie sur , WalkUpgradeDomain doit être appelé pour appliquer la mise à jour. Si la valeur `Auto` est spécifiée, la mise à jour est automatiquement appliquée à chaque domaine de mise à jour pour le service. L’élément `Mode` est disponible uniquement à l’aide de la version 2011-08-01 ou ultérieure. Le `Simultaneous` paramètre est disponible uniquement à l’aide de la version 2013-03-01 ou ultérieure.
Nom	facultatif. Représente le nom d'une propriété étendue du service cloud. Chaque propriété étendue doit avoir un nom et une valeur définis. Il peut y avoir un maximum de 25 paires nom/valeur de propriété étendue. La longueur maximale de l'élément `Name` est de 64 caractères, seuls les caractères alphanumériques et les traits de soulignement sont valides dans le nom, et celui-ci doit commencer par une lettre. Toute tentative d'utiliser d'autres caractères, en commençant par un caractère autre qu'une lettre, ou en entrant un nom qui est identique à celui d'une autre propriété étendue détenue par le même service cloud, provoque une erreur de code d'état 400 (erreur de mauvaise demande). L’élément `Name` est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure.
Valeur	Optionnel. Représente la valeur d'une propriété étendue du service cloud. Chaque propriété étendue doit avoir un nom et une valeur définis. Vous pouvez avoir 25 paires nom/valeur de propriété étendue au maximum, et chaque valeur de propriété étendue doit avoir une taille maximale de 255 caractères. Vous pouvez supprimer une propriété étendue en définissant la valeur NULL. L’élément `Value` est disponible uniquement à l’aide de la version 2012-03-01 ou ultérieure.
ExtensionConfiguration	Optionnel. Représente une extension qui est ajoutée au service cloud. Dans Azure, un processus peut fonctionner comme une extension d'un service cloud. Vous devez ajouter une extension au service cloud à l’aide de l’option Ajouter une extension avant de pouvoir être ajoutée au déploiement lors d’un changement de configuration. L’élément `ExtensionConfiguration` est disponible uniquement à l’aide de la version 2013-03-01 ou ultérieure.

ExtensionConfiguration

Représente une extension qui est ajoutée au service cloud.

Nom de l'élément	Description
AllRoles	Optionnel. Spécifie une liste d'extensions qui sont appliquées à tous les rôles dans un déploiement.
Extension	Obligatoire. Représente une extension qui doit être déployée dans un rôle dans un service cloud.
NamedRoles	Optionnel. Spécifie une liste d'extensions qui sont appliquées aux rôles spécifiques dans un déploiement.

Extension

Représente une extension qui doit être déployée dans un rôle dans un service cloud.

Nom de l'élément	Description
Id	Obligatoire. Identificateur de l'extension. L'identificateur est créé lorsque l'extension est ajoutée au service cloud. Vous pouvez trouver l’ID d’une extension qui a été ajoutée à un service cloud à l’aide des extensions de liste.
État	Optionnel. Spécifie l'état de l'extension. Cet élément s'applique uniquement aux extensions JSON configurées. Les valeurs possibles sont les suivantes : - `Enable` - `Disable` - `Uninstall` La valeur par défaut est `Enable`. L’élément `State` est disponible uniquement à l’aide de la version 2014-06-01 ou ultérieure.

NamedRoles

Spécifie une liste d'extensions qui sont appliquées aux rôles spécifiques dans un déploiement.

Nom de l'élément	Description
Role	Obligatoire. Représente un rôle spécifique auquel l'extension est ajoutée.
RoleName	Obligatoire. Indique le nom du rôle.
Extension	Obligatoire. Représente une extension qui doit être déployée dans un rôle dans un service cloud.

response

La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.

Étant donné qu’il Change Deployment Configuration s’agit d’une opération asynchrone, vous devez appeler Get Operation Status pour déterminer si l’opération est terminée, a échoué ou est toujours en cours.

Code d’état

Une opération réussie envoie le code d'état 200 (OK).

En-têtes de réponse

La réponse de l'opération inclut les en-têtes suivants. La réponse peut aussi inclure des en-têtes HTTP standard supplémentaires.

En-tête de réponse	Description
`x-ms-request-id`	Valeur qui identifie de façon unique une demande effectuée au service de gestion. Pour une opération asynchrone, vous pouvez appeler Obtenir l’état de l’opération avec la valeur de l’en-tête pour déterminer si l’opération est terminée, a échoué ou est toujours en cours.

Corps de la réponse

Aucun.

Partager via