Partager via


az blueprint

Remarque

Cette référence fait partie de l’extension blueprint pour Azure CLI (version 2.50.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az blueprint . En savoir plus sur les extensions.

Commandes pour gérer le blueprint.

Commandes

Nom Description Type Statut
az blueprint artifact

Commandes pour gérer l’artefact de blueprint.

Extension GA
az blueprint artifact delete

Supprimez un artefact de blueprint.

Extension Aperçu
az blueprint artifact list

Répertorier les artefacts d’une définition de blueprint donnée.

Extension Aperçu
az blueprint artifact policy

Commandes pour gérer l’artefact d’affectation de stratégie de blueprint.

Extension GA
az blueprint artifact policy create

Créez un artefact de stratégie de blueprint.

Extension GA
az blueprint artifact policy update

Mettre à jour l’artefact de stratégie de blueprint.

Extension GA
az blueprint artifact role

Commandes pour gérer l’artefact d’attribution de rôle de blueprint.

Extension GA
az blueprint artifact role create

Créez un artefact de rôle de blueprint.

Extension GA
az blueprint artifact role update

Mettre à jour l’artefact de rôle de blueprint.

Extension GA
az blueprint artifact show

Obtenir un artefact de blueprint.

Extension Aperçu
az blueprint artifact template

Commandes pour gérer l’artefact de modèle ARM de blueprint.

Extension GA
az blueprint artifact template create

Créez un artefact arm de blueprint.

Extension GA
az blueprint artifact template update

Mettre à jour l’artefact arm de blueprint.

Extension GA
az blueprint assignment

Commandes pour gérer l’affectation de blueprint.

Extension GA
az blueprint assignment create

Créez une affectation de blueprint.

Extension GA
az blueprint assignment delete

Supprimez une affectation de blueprint.

Extension Aperçu
az blueprint assignment list

Répertorier les affectations de blueprint dans un abonnement.

Extension Aperçu
az blueprint assignment show

Obtenir une affectation de blueprint.

Extension Aperçu
az blueprint assignment update

Mettez à jour une affectation de blueprint.

Extension GA
az blueprint assignment wait

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

Extension GA
az blueprint assignment who

Get Blueprint Servie Principal Name objectId.

Extension Aperçu
az blueprint create

Créez une définition de blueprint.

Extension Aperçu
az blueprint delete

Supprimez une définition de blueprint.

Extension Aperçu
az blueprint export

Exportez une définition de blueprint et des artefacts vers des fichiers json.

Extension GA
az blueprint import

Importez une définition de blueprint et des artefacts à partir d’un directoy de fichiers json.

Extension GA
az blueprint list

Répertorier les définitions de blueprint.

Extension Aperçu
az blueprint publish

Publiez une nouvelle version de la définition de blueprint avec les derniers artefacts. Les définitions de blueprint publiées sont immuables.

Extension Aperçu
az blueprint resource-group

Commandes pour gérer l’artefact de groupe de ressources blueprint.

Extension GA
az blueprint resource-group add

Ajoutez un artefact de groupe de ressources au blueprint.

Extension GA
az blueprint resource-group list

Répertorier l’artefact du groupe de ressources blueprint.

Extension GA
az blueprint resource-group remove

Supprimez un artefact de groupe de ressources blueprint.

Extension GA
az blueprint resource-group show

Afficher l’artefact du groupe de ressources blueprint.

Extension GA
az blueprint resource-group update

Mettre à jour l’artefact du groupe de ressources blueprint.

Extension GA
az blueprint show

Obtenir une définition de blueprint.

Extension Aperçu
az blueprint update

Mettez à jour une définition de blueprint.

Extension Aperçu
az blueprint version

Commandes pour gérer les versions de blueprint publiées.

Extension Aperçu
az blueprint version artifact

Commandes pour gérer les artefacts de blueprint publiés.

Extension Aperçu
az blueprint version artifact list

Répertorier les artefacts d’une version d’un blueprint publié.

Extension Aperçu
az blueprint version artifact show

Afficher un artefact pour un blueprint publié.

Extension Aperçu
az blueprint version delete

Supprimez une version publiée d’un blueprint.

Extension Aperçu
az blueprint version list

Répertorier les versions publiées de la définition de blueprint donnée.

Extension Aperçu
az blueprint version show

Obtenir une version publiée d’un blueprint.

Extension Aperçu

az blueprint create

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez une définition de blueprint.

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

Exemples

Créer un blueprint d’abonnement

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

Créer un blueprint de groupe d’administration

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

Paramètres obligatoires

--name -n

Nom de la définition du blueprint.

--target-scope

Étendue dans laquelle cette définition de blueprint peut être affectée.

valeurs acceptées: managementGroup, subscription

Paramètres facultatifs

--description

Les lignes multiples expliquent cette ressource.

--display-name

La chaîne d’un liner explique cette ressource.

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--parameters -p

Paramètres requis par cette définition de blueprint. Il peut s’agir d’une chaîne JSON ou d’un chemin de fichier JSON. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--resource-groups

Espaces réservés de groupe de ressources définis par cette définition de blueprint. Valeur attendue : json-string/@json-file. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint delete

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez une définition de blueprint.

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemples

Supprimer un blueprint de groupe d’administration

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

Supprimer un blueprint d’abonnement

az blueprint delete --subscription MySubscription --name MyBlueprint

Paramètres obligatoires

--name -n

Nom de la définition du blueprint.

Paramètres facultatifs

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

--yes -y

Ne pas demander de confirmation.

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

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint export

Exportez une définition de blueprint et des artefacts vers des fichiers json.

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemples

Exporter une définition de blueprint et des artefacts

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

Paramètres obligatoires

--name -n

Nom de la définition de blueprint à exporter.

--output-path

Chemin d’accès au répertoire pour les définitions json des blueprints et des artefacts. Le fichier de définition de blueprint sera nommé blueprint.json. Les fichiers json d’artefacts se trouveront dans un sous-répertoire nommé artefacts.

Paramètres facultatifs

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

--yes -y

Ignorez la confirmation de l’utilisateur. Quand elle est définie, si le répertoire n’existe pas, il est créé. Si le répertoire existe et a du contenu, il est remplacé. S’il n’est pas défini, l’utilisateur est invité à demander l’autorisation de continuer.

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

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint import

Importez une définition de blueprint et des artefacts à partir d’un directoy de fichiers json.

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Exemples

Importer une définition de blueprint et des artefacts

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

Paramètres obligatoires

--input-path

Chemin d’accès au répertoire pour les définitions json des blueprints et des artefacts. Le fichier de définition de blueprint doit être nommé blueprint.json. Les fichiers json d’artefacts doivent se trouver dans un sous-répertoire nommé artefacts.

--name -n

Nom de la définition du blueprint.

Paramètres facultatifs

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

--yes -y

Ne pas demander de confirmation.

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

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint list

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Répertorier les définitions de blueprint.

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

Exemples

Répertorier les blueprints dans un groupe d’administration

az blueprint list --management-group MyManagementGroup

Répertorier les blueprints dans un abonnement

az blueprint list --subscription MySubscription

Paramètres facultatifs

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint publish

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Publiez une nouvelle version de la définition de blueprint avec les derniers artefacts. Les définitions de blueprint publiées sont immuables.

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

Exemples

Publier un blueprint de groupe d’administration

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

Publier un blueprint d’abonnement

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

Paramètres obligatoires

--blueprint-name

Nom de la définition du blueprint.

--version

Version de la définition de blueprint publiée.

Paramètres facultatifs

--change-notes

Notes de modification spécifiques à la version.

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint show

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Obtenir une définition de blueprint.

az blueprint show --name
                  [--management-group]
                  [--subscription]

Exemples

Afficher un blueprint de groupe d’administration

az blueprint show --management-group MyManagementGroup --name MyBlueprint

Afficher un blueprint d’abonnement

az blueprint show --subscription MySubscription --name MyBlueprint

Paramètres obligatoires

--name -n

Nom de la définition du blueprint.

Paramètres facultatifs

--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az blueprint update

Préversion

Cette commande est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour une définition de blueprint.

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

Paramètres obligatoires

--name -n

Nom de la définition du blueprint.

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--description

Les lignes multiples expliquent cette ressource.

--display-name

La chaîne d’un liner explique cette ressource.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--management-group -m

Utilisez le groupe d’administration pour l’étendue du blueprint.

--parameters -p

Paramètres requis par cette définition de blueprint. Il peut s’agir d’une chaîne JSON ou d’un chemin de fichier JSON. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-groups

Espaces réservés de groupe de ressources définis par cette définition de blueprint. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--subscription -s

Utilisez l’abonnement pour l’étendue du blueprint. Si --management-group n’est pas spécifié, la valeur --subscription ou l’abonnement par défaut sera utilisé comme étendue.

--target-scope

Étendue dans laquelle cette définition de blueprint peut être affectée.

valeurs acceptées: managementGroup, subscription
Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher 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êtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.