Partager via

az blueprint assignment

  • Référence

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 d’affectation de blueprint az. En savoir plus sur les extensions.

Commandes pour gérer l’affectation de blueprint.

Commandes

Nom Description Type Statut
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 assignment create

Créez une affectation de blueprint.

az blueprint assignment create --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

Exemples

Affectation avec l’identité managée affectée par le système

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type SystemAssigned \
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/provid \
ers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=westus \
--resource-group-value artifact_name=rg-art-2 name=rg2 location=eastus \
--parameters "path/to/parameter/file" \

Affectation avec une identité managée affectée par l’utilisateur

az blueprint assignment create --subscription MySubscription --name \
MyBlueprintAssignment --location eastus --identity-type UserAssigned \
--user-assigned-identity "/subscriptions/00000000-0000-0000-0000-000000000000 \
/resourcegroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"\
--description "Enforce pre-defined MyBlueprint to this subscription." \
--blueprint-version "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup \
/providers/Microsoft.Blueprint/blueprints/MyBlueprint/versions/v2" \
--resource-group-value artifact_name=rg-art-1 name=rg1 location=eastus \
--parameters "path/to/parameter/file" \

Paramètres obligatoires

--name -n

Nom de l’affectation de blueprint.

Paramètres facultatifs

--blueprint-version

ID de ressource de la version publiée d’une définition de blueprint.

--description

Les lignes multiples expliquent cette ressource.

--display-name

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

--identity-type

Type de l’identité managée.

valeurs acceptées: None, SystemAssigned, UserAssigned
valeur par défaut: SystemAssigned
--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--locks-excluded-principals

Liste des principaux AAD exclus des verrous de blueprint. Jusqu’à 5 principaux sont autorisés.

--locks-mode

Mode de verrouillage.

valeurs acceptées: AllResourcesDoNotDelete, AllResourcesReadOnly, None
--management-group -m

Utilisez le groupe d’administration pour l’étendue cible de l’affectation de blueprint. Elle est réservée à une utilisation future. Utilisez plutôt --subscription.

--parameters -p

Valeurs des paramètres d’affectation de blueprint. Il peut s’agir d’une chaîne JSON ou d’un chemin de fichier JSON.

--resource-group-value

Paires Clé=Valeur pour un groupe de ressources. Les clés incluent « artifact_name » (obligatoire), « name », « location ».

--subscription -s

Utilisez l’abonnement pour l’étendue cible de l’affectation de blueprint. La susbcription par défaut est utilisée si l’option n’est pas spécifiée.

--user-assigned-identity

Identité managée affectée par l’utilisateur associée à la ressource.

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 assignment 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 affectation de blueprint.

az blueprint assignment delete --name
                               [--delete-behavior {all, none}]
                               [--management-group]
                               [--subscription]
                               [--yes]

Exemples

Supprimer une affectation

az blueprint assignment delete --subscription MySubscription --name MyBlueprintAssignment

Paramètres obligatoires

--name -n

Nom de l’affectation de blueprint.

Paramètres facultatifs

--delete-behavior

Lorsque deleteBehavior=all, les ressources créées par l’affectation de blueprint sont supprimées.

valeurs acceptées: all, none
--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 assignment 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 affectations de blueprint dans un abonnement.

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

Exemples

Lister les devoirs

az blueprint assignment 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 assignment 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 affectation de blueprint.

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

Exemples

Afficher une affectation

az blueprint assignment show --subscription MySubscription --name MyBlueprintAssignment

Paramètres obligatoires

--name -n

Nom de l’affectation de 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 assignment update

Mettez à jour une affectation de blueprint.

az blueprint assignment update --name
                               [--blueprint-version]
                               [--description]
                               [--display-name]
                               [--identity-type {None, SystemAssigned, UserAssigned}]
                               [--location]
                               [--locks-excluded-principals]
                               [--locks-mode {AllResourcesDoNotDelete, AllResourcesReadOnly, None}]
                               [--management-group]
                               [--parameters]
                               [--resource-group-value]
                               [--subscription]
                               [--user-assigned-identity]

Paramètres obligatoires

--name -n

Nom de l’affectation de blueprint.

Paramètres facultatifs

--blueprint-version

ID de ressource de la version publiée d’une définition de blueprint.

--description

Les lignes multiples expliquent cette ressource.

--display-name

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

--identity-type

Type de l’identité managée.

valeurs acceptées: None, SystemAssigned, UserAssigned
--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--locks-excluded-principals

Liste des principaux AAD exclus des verrous de blueprint. Jusqu’à 5 principaux sont autorisés.

--locks-mode

Mode de verrouillage.

valeurs acceptées: AllResourcesDoNotDelete, AllResourcesReadOnly, None
--management-group -m

Utilisez le groupe d’administration pour l’étendue cible de l’affectation de blueprint. Elle est réservée à une utilisation future. Utilisez plutôt --subscription.

--parameters -p

Valeurs des paramètres d’affectation de blueprint. Il peut s’agir d’une chaîne JSON ou d’un chemin de fichier JSON.

--resource-group-value

Paires Clé=Valeur pour un groupe de ressources. Les clés incluent « artifact_name » (obligatoire), « name », « location ».

--subscription -s

Utilisez l’abonnement pour l’étendue cible de l’affectation de blueprint. La susbcription par défaut est utilisée si l’option n’est pas spécifiée.

--user-assigned-identity

Identité managée affectée par l’utilisateur associée à la ressource.

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 assignment wait

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

az blueprint assignment wait --name
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--interval]
                             [--management-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que l’affectation de blueprint soit correctement provisionnée.

az blueprint assignment wait --subscription MySubscription \ --name MyBlueprintAssignment --created

Paramètres obligatoires

--name -n

Nom de l’affectation de blueprint.

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
--management-group -m

Utilisez le groupe d’administration pour l’étendue cible de l’affectation de blueprint. Elle est réservée à une utilisation future. Utilisez plutôt --subscription.

--subscription -s

Utilisez l’abonnement pour l’étendue cible de l’affectation de blueprint. La susbcription par défaut est utilisée si l’option n’est pas spécifiée.

--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 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 assignment who

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

Get Blueprint Servie Principal Name objectId.

az blueprint assignment who --name
                            [--management-group]
                            [--subscription]

Exemples

Get SPN objectId

az blueprint assignment who --subscription MySubscription --name MyBlueprintAssignment

Paramètres obligatoires

--name -n

Nom de l’affectation de 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.