Partager via

az deployment group

  • Référence

Gérer le déploiement de modèles Azure Resource Manager au niveau du groupe de ressources.

Commandes

Nom Description Type État
az deployment group cancel

Annulez un déploiement au niveau du groupe de ressources.

 Noyau GA
az deployment group create

Démarrez un déploiement au niveau du groupe de ressources.

 Noyau GA
az deployment group delete

Supprimez un déploiement au niveau du groupe de ressources.

 Noyau GA
az deployment group export

Exportez le modèle utilisé pour un déploiement.

 Noyau GA
az deployment group list

Répertorier les déploiements au niveau du groupe de ressources.

 Noyau GA
az deployment group show

Afficher un déploiement au niveau du groupe de ressources.

 Noyau GA
az deployment group validate

Vérifiez si un modèle est valide au niveau du groupe de ressources.

 Noyau GA
az deployment group wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de déploiement soit remplie.

 Noyau GA
az deployment group what-if

Exécutez une opération de déploiement What-If au niveau de l’étendue du groupe de ressources.

 Noyau GA

az deployment group cancel

Modifier

Annulez un déploiement au niveau du groupe de ressources.

az deployment group cancel --name
                           --resource-group

Exemples

Annulez un déploiement au niveau du groupe de ressources.

az deployment group cancel -g testrg -n deployment01

Paramètres obligatoires

--name -n

Nom du déploiement.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group create

Modifier

Démarrez un déploiement au niveau du groupe de ressources.

Spécifiez un seul fichier --template-file | --template-uri URI | --template-spec pour entrer le modèle ARM.

az deployment group create --resource-group
                           [--aux-subs]
                           [--aux-tenants]
                           [--confirm-with-what-if]
                           [--handle-extended-json-format]
                           [--mode {Complete, Incremental}]
                           [--name]
                           [--no-prompt {false, true}]
                           [--no-wait]
                           [--parameters]
                           [--proceed-if-no-change]
                           [--query-string]
                           [--rollback-on-error]
                           [--template-file]
                           [--template-spec]
                           [--template-uri]
                           [--what-if]
                           [--what-if-exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                           [--what-if-result-format {FullResourcePayloads, ResourceIdOnly}]

Exemples

Créez un déploiement sur un groupe de ressources à partir d’un fichier de modèle distant, à l’aide de paramètres à partir d’un fichier JSON local.

az deployment group create --resource-group testrg --name rollout01 \
    --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Créez un déploiement au niveau du groupe de ressources à partir d’un fichier de modèle local, à l’aide de paramètres à partir d’une chaîne JSON.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  \
    --parameters '{ \"policyName\": { \"value\": \"policy2\" } }'

Créez un déploiement au niveau du groupe de ressources à partir d’un fichier de modèle local, à l’aide de paramètres à partir d’une chaîne de tableau.

az deployment group create --resource-group testgroup --template-file demotemplate.json --parameters exampleString='inline string' exampleArray='("value1", "value2")'

Créez un déploiement sur un groupe de ressources à partir d’un modèle local, à l’aide d’un fichier de paramètres, d’un fichier de paramètres distant et de substitution sélective de paires clé/valeur.

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json  --parameters @params.json \
    --parameters https://mysite/params.json --parameters MyValue=This MyArray=@array.json

Créer un déploiement au niveau de l’étendue du groupe de ressources à partir d’une spécification de modèle

az deployment group create --resource-group testrg --template-spec "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Resources/templateSpecs/myTemplateSpec/versions/1.0"

Créer un déploiement au niveau de l’étendue du groupe de ressources à partir d’un fichier de paramètres bicepparam

az deployment group create --resource-group testrg --parameters parameters.bicepparam

Créer un déploiement au niveau du groupe de ressources entre les locataires

az deployment group create --resource-group testrg --name rollout01 \
    --template-file azuredeploy.json --parameters @myparameters.json --aux-tenants auxiliary_tenant01 auxiliary_tenant02

Paramètres obligatoires

--resource-group -g

Groupe de ressources auquel créer le déploiement.

Paramètres facultatifs

--aux-subs
Déprécié

L’option « --aux-subs » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --aux-tenants ».

Abonnements auxiliaires qui seront utilisés pendant le déploiement entre les locataires.

--aux-tenants

Locataires auxiliaires qui seront utilisés pendant le déploiement entre les locataires.

--confirm-with-what-if -c

Indiquez à la commande d’exécuter le déploiement What-If avant d’exécuter le déploiement. Il vous invite ensuite à accuser réception des modifications des ressources avant de continuer.

--handle-extended-json-format -j
Déprécié

L’option '--handle-extended-json-format/-j’a été déconseillée et sera supprimée dans une prochaine version.

Prise en charge de la gestion du contenu de modèle étendu, y compris le multiligne et les commentaires dans le déploiement.

--mode

Mode de déploiement.

Valeurs acceptées: Complete, Incremental
Valeur par défaut: Incremental
--name -n

Nom du déploiement.

--no-prompt

Option permettant de désactiver l’invite de paramètres manquants pour le modèle ARM. Lorsque la valeur est true, l’invite demandant aux utilisateurs de fournir un paramètre manquant est ignorée. La valeur par défaut est false.

Valeurs acceptées: false, true
Valeur par défaut: False
--no-wait

N’attendez pas la fin de l’opération de longue durée.

Valeur par défaut: False
--parameters -p

Fournissez les valeurs des paramètres de déploiement.

Les paramètres peuvent être fournis à partir d’un fichier à l’aide de la syntaxe @{path}, d’une chaîne JSON ou de paires <KEY=VALUE>. Les paramètres sont évalués dans l’ordre. Par conséquent, lorsqu’une valeur est affectée deux fois, la dernière valeur sera utilisée. Il est recommandé de fournir d’abord votre fichier de paramètres, puis de remplacer de manière sélective à l’aide de la syntaxe KEY=VALUE. Notez également que si vous fournissez un fichier bicepparam, vous ne pouvez utiliser cet argument qu’une seule fois.

--proceed-if-no-change

Indiquez à la commande d’exécuter le déploiement si le résultat What-If ne contient aucune modification des ressources. Applicable lorsque --confirm-with-what-if est défini.

--query-string -q

Chaîne de requête (jeton SAP) à utiliser avec l’URI de modèle dans le cas de modèles liés.

--rollback-on-error

Nom d’un déploiement à restaurer en cas d’erreur ou utiliser comme indicateur pour revenir au dernier déploiement réussi.

--template-file -f

Chemin d’accès au fichier de modèle ou au fichier Bicep.

--template-spec -s

ID de ressource de spécification du modèle.

--template-uri -u

URI du fichier de modèle.

--what-if -w

Indiquez à la commande d’exécuter le déploiement What-If.

--what-if-exclude-change-types -x

Liste séparée par l’espace des types de modification des ressources à exclure des résultats What-If. Applicable lorsque --confirm-with-what-if est défini.

Valeurs acceptées: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--what-if-result-format -r

Format des résultats What-If. Applicable lorsque --confirm-with-what-if est défini.

Valeurs acceptées: FullResourcePayloads, ResourceIdOnly
Valeur par défaut: FullResourcePayloads
Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group delete

Modifier

Supprimez un déploiement au niveau du groupe de ressources.

az deployment group delete --name
                           --resource-group
                           [--no-wait]

Exemples

Supprimez un déploiement au niveau du groupe de ressources.

az deployment group delete -g testrg -n deployment01

Paramètres obligatoires

--name -n

Nom du déploiement.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

--no-wait

N’attendez pas la fin de l’opération de longue durée.

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group export

Modifier

Exportez le modèle utilisé pour un déploiement.

az deployment group export --name
                           --resource-group

Exemples

Exportez le modèle utilisé pour un déploiement au niveau du groupe de ressources.

az deployment group export --resource-group testrg --name MyDeployment

Paramètres obligatoires

--name -n

Nom du déploiement.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group list

Modifier

Répertorier les déploiements au niveau du groupe de ressources.

az deployment group list --resource-group
                         [--filter]

Exemples

Répertorier les déploiements au niveau du groupe de ressources.

az deployment group list -g testrg

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

--filter
Préversion

Expression de filtre à l’aide de la notation OData. Vous pouvez utiliser --filter « provisioningState eq ' {state} » pour filtrer provisioningState. Pour obtenir plus d’informations, visitez https://learn.microsoft.com/rest/api/resources/deployments/listatsubscriptionscope#uri-parameters.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group show

Modifier

Afficher un déploiement au niveau du groupe de ressources.

az deployment group show --name
                         --resource-group

Exemples

Afficher un déploiement au niveau du groupe de ressources.

az deployment group show -g testrg -n deployment01

Paramètres obligatoires

--name -n

Nom du déploiement.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group validate

Modifier

Vérifiez si un modèle est valide au niveau du groupe de ressources.

Spécifiez un seul fichier --template-file | --template-uri URI | --template-spec pour entrer le modèle ARM.

az deployment group validate --resource-group
                             [--handle-extended-json-format]
                             [--mode {Complete, Incremental}]
                             [--name]
                             [--no-prompt {false, true}]
                             [--parameters]
                             [--query-string]
                             [--rollback-on-error]
                             [--template-file]
                             [--template-spec]
                             [--template-uri]

Exemples

Vérifiez si un modèle est valide au niveau du groupe de ressources.

az deployment group validate --resource-group testrg --template-file {template-file}

Vérifiez si un modèle est valide au niveau du groupe de ressources. (généré automatiquement)

az deployment group validate --parameters MyValue=This MyArray=@array.json --resource-group testrg --template-file azuredeploy.json

Paramètres obligatoires

--resource-group -g

Groupe de ressources auquel créer le déploiement.

Paramètres facultatifs

--handle-extended-json-format -j
Déprécié

L’option '--handle-extended-json-format/-j’a été déconseillée et sera supprimée dans une prochaine version.

Prise en charge de la gestion du contenu de modèle étendu, y compris le multiligne et les commentaires dans le déploiement.

--mode

Mode de déploiement.

Valeurs acceptées: Complete, Incremental
Valeur par défaut: Incremental
--name -n

Nom du déploiement.

--no-prompt

Option permettant de désactiver l’invite de paramètres manquants pour le modèle ARM. Lorsque la valeur est true, l’invite demandant aux utilisateurs de fournir un paramètre manquant est ignorée. La valeur par défaut est false.

Valeurs acceptées: false, true
Valeur par défaut: False
--parameters -p

Fournissez les valeurs des paramètres de déploiement.

Les paramètres peuvent être fournis à partir d’un fichier à l’aide de la syntaxe @{path}, d’une chaîne JSON ou de paires <KEY=VALUE>. Les paramètres sont évalués dans l’ordre. Par conséquent, lorsqu’une valeur est affectée deux fois, la dernière valeur sera utilisée. Il est recommandé de fournir d’abord votre fichier de paramètres, puis de remplacer de manière sélective à l’aide de la syntaxe KEY=VALUE.

--query-string -q

Chaîne de requête (jeton SAP) à utiliser avec l’URI de modèle dans le cas de modèles liés.

--rollback-on-error

Nom d’un déploiement à restaurer en cas d’erreur ou utiliser comme indicateur pour revenir au dernier déploiement réussi.

--template-file -f

Chemin d’accès au fichier de modèle ou au fichier Bicep.

--template-spec -s

ID de ressource de spécification du modèle.

--template-uri -u

URI du fichier de modèle.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group wait

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de déploiement soit remplie.

az deployment group wait --name
                         --resource-group
                         [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--interval]
                         [--timeout]
                         [--updated]

Exemples

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de déploiement soit remplie. (généré automatiquement)

az deployment group wait --created --name MyDeployment --resource-group MyResourceGroup

Paramètres obligatoires

--name -n

Nom du déploiement.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

Valeur par défaut: False
--exists

Attendez que la ressource existe.

Valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

Valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

Valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az deployment group what-if

Modifier

Exécutez une opération de déploiement What-If au niveau de l’étendue du groupe de ressources.

Spécifiez un seul fichier --template-file | --template-uri URI | --template-spec pour entrer le modèle ARM.

az deployment group what-if --resource-group
                            [--aux-tenants]
                            [--exclude-change-types {Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported}]
                            [--mode {Complete, Incremental}]
                            [--name]
                            [--no-pretty-print]
                            [--no-prompt {false, true}]
                            [--parameters]
                            [--query-string]
                            [--result-format {FullResourcePayloads, ResourceIdOnly}]
                            [--template-file]
                            [--template-spec]
                            [--template-uri]

Exemples

Exécutez une opération de déploiement What-If sur un groupe de ressources.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json

Exécutez une opération de déploiement What-If au format ResourceIdOnly d’un groupe de ressources.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --result-format ResourceIdOnly

Exécutez un déploiement What-If opération sur un groupe de ressources sans imprimer le résultat.

az deployment group what-if --resource-group testrg --name rollout01 --template-uri https://myresource/azuredeploy.json --parameters @myparameters.json --no-pretty-print

Paramètres obligatoires

--resource-group -g

Groupe de ressources sur lequel exécuter l’opération de déploiement What-If.

Paramètres facultatifs

--aux-tenants

Locataires auxiliaires qui seront utilisés pendant le déploiement entre les locataires.

--exclude-change-types -x

Liste séparée par l’espace des types de modification des ressources à exclure des résultats What-If.

Valeurs acceptées: Create, Delete, Deploy, Ignore, Modify, NoChange, Unsupported
--mode

Mode de déploiement.

Valeurs acceptées: Complete, Incremental
Valeur par défaut: Incremental
--name -n

Nom du déploiement.

--no-pretty-print

Désactivez l’impression jolie pour les résultats What-If. Lorsqu’il est défini, le type de format de sortie est utilisé.

--no-prompt

Option permettant de désactiver l’invite de paramètres manquants pour le modèle ARM. Lorsque la valeur est true, l’invite demandant aux utilisateurs de fournir un paramètre manquant est ignorée. La valeur par défaut est false.

Valeurs acceptées: false, true
Valeur par défaut: False
--parameters -p

Fournissez les valeurs des paramètres de déploiement.

Les paramètres peuvent être fournis à partir d’un fichier à l’aide de la syntaxe @{path}, d’une chaîne JSON ou de paires <KEY=VALUE>. Les paramètres sont évalués dans l’ordre. Par conséquent, lorsqu’une valeur est affectée deux fois, la dernière valeur sera utilisée. Il est recommandé de fournir d’abord votre fichier de paramètres, puis de remplacer de manière sélective à l’aide de la syntaxe KEY=VALUE.

--query-string -q

Chaîne de requête (jeton SAP) à utiliser avec l’URI de modèle dans le cas de modèles liés.

--result-format -r

Format des résultats What-If.

Valeurs acceptées: FullResourcePayloads, ResourceIdOnly
Valeur par défaut: FullResourcePayloads
--template-file -f

Chemin d’accès au fichier de modèle ou au fichier Bicep.

--template-spec -s

ID de ressource de spécification du modèle.

--template-uri -u

URI du fichier de modèle.

Paramètres globaux
--debug

Augmentez la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requête JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.