Partager via

az scvmm vm extension

  • Référence

Remarque

Cette référence fait partie de l’extension scvmm 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 de machine virtuelle az scvmm. En savoir plus sur les extensions.

Gérer l’extension de machine virtuelle avec scvmm.

Commandes

Nom Description Type Statut
az scvmm vm extension create

Opération de création de l’extension.

 Extension GA
az scvmm vm extension delete

Opération de suppression de l’extension.

 Extension GA
az scvmm vm extension list

Opération permettant d’obtenir toutes les extensions d’une machine virtuelle non-Azure.

 Extension GA
az scvmm vm extension show

Opération d’obtention de l’extension.

 Extension GA
az scvmm vm extension update

Opération de mise à jour de l’extension.

 Extension GA

az scvmm vm extension create

Opération de création de l’extension.

az scvmm vm extension create --location
                             --name
                             --resource-group
                             --vm-name
                             [--auto-upgrade-minor {false, true}]
                             [--enable-auto-upgrade {false, true}]
                             [--force-update-tag]
                             [--no-wait]
                             [--protected-settings]
                             [--publisher]
                             [--settings]
                             [--tags]
                             [--type]
                             [--type-handler-version]

Exemples

Créer une extension de machine virtuelle

az scvmm vm extension create --name contoso-extension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg

Paramètres obligatoires

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

--name

Nom de l’extension de machine virtuelle.

--resource-group -g

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

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

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

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--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.

--settings

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

--tags

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

--type

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

--type-handler-version

Spécifie 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 scvmm vm extension delete

Opération de suppression de l’extension.

az scvmm vm extension delete [--ids]
                             [--name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
                             [--vm-name]
                             [--yes]

Exemples

Supprimer une extension de machine virtuelle

az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-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 virtuelle.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--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.

--vm-name

Nom de la machine virtuelle où 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 scvmm vm extension list

Opération permettant d’obtenir toutes les extensions d’une machine virtuelle non-Azure.

az scvmm vm extension list --resource-group
                           --vm-name
                           [--expand]

Exemples

Obtenir toutes les extensions de machine virtuelle

az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-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>.

--vm-name

Nom de la machine virtuelle contenant l’extension.

Paramètres facultatifs

--expand

Expression de développement à appliquer à l’opération.

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 scvmm vm extension show

Opération d’obtention de l’extension.

az scvmm vm extension show [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--vm-name]

Exemples

Obtenir l’extension de machine virtuelle

az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-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 virtuelle.

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

--vm-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 scvmm vm extension update

Opération de mise à jour de l’extension.

az scvmm vm extension update --name
                             --resource-group
                             --vm-name
                             [--auto-upgrade-minor {false, true}]
                             [--enable-auto-upgrade {false, true}]
                             [--force-update-tag]
                             [--no-wait]
                             [--protected-settings]
                             [--publisher]
                             [--settings]
                             [--tags]
                             [--type]
                             [--type-handler-version]

Exemples

Mettre à jour une extension de machine virtuelle

az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg

Paramètres obligatoires

--name

Nom de l’extension de machine virtuelle.

--resource-group -g

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

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

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

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--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.

--settings

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

--tags

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

--type

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

--type-handler-version

Spécifie 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.