Partager via

az azurestackhci virtualmachine extension

  • Expérimental
  • Référence

Remarque

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

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Gérer l’extension virtualmachine avec azurestackhci.

Commandes

Nom Description Type Statut
az azurestackhci virtualmachine extension create

Créez une extension virtualmachine.

 Extension Expérimental
az azurestackhci virtualmachine extension delete

Supprimez une extension virtualmachine.

 Extension Expérimental
az azurestackhci virtualmachine extension list

Répertorier toutes les extensions d’une machine virtuelle.

 Extension Expérimental
az azurestackhci virtualmachine extension show

Obtenez les détails d’une extension virtualmachine.

 Extension Expérimental
az azurestackhci virtualmachine extension update

Mettez à jour une extension virtualmachine.

 Extension Expérimental
az azurestackhci virtualmachine extension wait

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

 Extension Expérimental

az azurestackhci virtualmachine extension create

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez une extension virtualmachine.

az azurestackhci virtualmachine extension create --name
                                                 --resource-group
                                                 --virtualmachine-name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--inst-handler-version]
                                                 [--instance-view-type]
                                                 [--location]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--settings]
                                                 [--status]
                                                 [--tags]
                                                 [--type-handler-version]

Exemples

PutExtension

az azurestackhci virtualmachine extension create --resource-group "test-rg" --location "West US2" --name "test-extension" --extension-type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10" --virtualmachine-name "test-virtualmachine"

Paramètres obligatoires

--name

Le nom de l'entité d'extension.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--virtualmachine-name

Nom de la machine virtuelle où l’extension doit être créée ou mise à jour.

Paramètres facultatifs

--auto-upgrade-minor

Indiquez si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.

valeurs acceptées: false, true
--enable-auto-upgrade

Indiquez si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente disponible.

valeurs acceptées: false, true
--extension-type

Spécifiez le type de l’extension virtualmachine ; Un exemple est CustomScriptExtension.

--force-update-tag

Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.

--inst-handler-version

Spécifiez la version du gestionnaire de scripts.

--instance-view-type

Spécifiez le type de l’extension ; un exemple est « CustomScriptExtension ».

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

--protected-settings

L’extension peut contenir des paramètres protégés Paramètres ou protégés Paramètres FromKeyVault ou aucun paramètre protégé du tout. Valeur attendue : json-string/json-file/@json-file.

--publisher

Nom de l’éditeur du gestionnaire d’extensions virtualmachine.

--settings

Paramètres publics au format Json pour l’extension virtualmachine.

--status

État de l’affichage de l’instance.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--type-handler-version

Spécifiez la version du gestionnaire de scripts.

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 azurestackhci virtualmachine extension delete

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez une extension virtualmachine.

az azurestackhci virtualmachine extension delete [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--virtualmachine-name]
                                                 [--yes]

Exemples

DeleteExtension

az azurestackhci virtualmachine extension delete --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name

Nom de l’extension de machine.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

--virtualmachine-name

Nom de la machine virtuelle à partir de laquelle l’extension doit être supprimée.

--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 azurestackhci virtualmachine extension list

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Répertorier toutes les extensions d’une machine virtuelle.

az azurestackhci virtualmachine extension list --resource-group
                                               --virtualmachine-name

Exemples

ListExtensions

az azurestackhci virtualmachine extension list --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--virtualmachine-name

Nom de la machine virtuelle contenant l’extension.

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 azurestackhci virtualmachine extension show

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Obtenez les détails d’une extension virtualmachine.

az azurestackhci virtualmachine extension show [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--virtualmachine-name]

Exemples

GetExtension

az azurestackhci virtualmachine extension show --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name

Nom de l’extension de machine.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

--virtualmachine-name

Nom de la machine virtuelle contenant l’extension.

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 azurestackhci virtualmachine extension update

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour une extension virtualmachine.

az azurestackhci virtualmachine extension update --name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--ids]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--resource-group]
                                                 [--settings]
                                                 [--subscription]
                                                 [--tags]
                                                 [--type-handler-version]
                                                 [--virtualmachine-name]

Exemples

UpdateExtension

az azurestackhci virtualmachine extension update --resource-group "test-rg" --name "test-extension" --extension-type "CustomScriptExtension" --virtualmachine-name "test-virtualmachine" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10"

Paramètres obligatoires

--name

Le nom de l'entité d'extension.

Paramètres facultatifs

--auto-upgrade-minor

Indiquez si l’extension doit utiliser une version mineure plus récente si elle est disponible au moment du déploiement. Cependant, une fois déployée, l’extension ne mettra pas à jour les versions mineures à moins d’être redéployée, même si cette propriété est définie sur true.

valeurs acceptées: false, true
--enable-auto-upgrade

Indiquez si l’extension doit être automatiquement mise à niveau par la plateforme s’il existe une version plus récente disponible.

valeurs acceptées: false, true
--extension-type

Spécifiez le type de l’extension ; un exemple est « CustomScriptExtension ».

--force-update-tag

Comment le gestionnaire d’extensions doit être forcé de mettre à jour même si la configuration de l’extension n’a pas changé.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--protected-settings

L’extension peut contenir des paramètres protégés Paramètres ou protégés Paramètres FromKeyVault ou aucun paramètre protégé du tout. Valeur attendue : json-string/json-file/@json-file.

--publisher

Nom du serveur de publication du gestionnaire d’extensions.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--settings

Paramètres publics au format Json pour l’extension. Valeur attendue : json-string/json-file/@json-file.

--subscription

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

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--type-handler-version

Spécifiez la version du gestionnaire de scripts.

--virtualmachine-name

Nom de la machine virtuelle contenant l’extension.

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 azurestackhci virtualmachine extension wait

Expérimental

Le groupe de commandes « azurestackhci » est expérimental et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

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

az azurestackhci virtualmachine extension wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]
                                               [--virtualmachine-name]

Exemples

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que l’extension virtualmachine soit correctement créée.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --created

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que l’extension virtualmachine soit correctement mise à jour.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --updated

Suspendre l’exécution de la ligne de script CLI suivante jusqu’à ce que l’extension virtualmachine soit correctement supprimée.

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --deleted

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
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--name

Nom de l’extension de machine.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

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

--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
--virtualmachine-name

Nom de la machine virtuelle contenant l’extension.

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.