az vm extension

  • Référence

Gérer les extensions sur les machines virtuelles.

Les extensions sont de petites applications qui fournissent des tâches de configuration post-déploiement et d’automatisation sur des machines virtuelles Azure. Par exemple, si une machine virtuelle requiert l’installation d’un logiciel, une protection antivirus ou une configuration de Docker, il est possible d’effectuer ces tâches à l’aide d’une extension de machine virtuelle. Les extensions peuvent être associées à un nouveau déploiement de machine virtuelle ou s’exécuter sur tout système existant.

Commandes

Nom Description Type Statut
az vm extension delete

Opération de suppression pour supprimer l’extension.

 Core GA
az vm extension image

Recherchez les extensions de machine virtuelle disponibles pour un abonnement et une région.

 Core GA
az vm extension image list

Répertoriez les informations sur les extensions disponibles.

 Core GA
az vm extension image list-names

Répertoriez les noms des extensions disponibles.

 Core GA
az vm extension image list-versions

Répertoriez les versions des extensions disponibles.

 Core GA
az vm extension image show

Afficher des informations pour une extension.

 Core GA
az vm extension list

Répertoriez les extensions attachées à une machine virtuelle.

 Core GA
az vm extension set

Définissez des extensions pour une machine virtuelle.

 Core GA
az vm extension show

Affichez des informations sur les extensions attachées à une machine virtuelle.

 Core GA
az vm extension wait

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

 Core GA

az vm extension delete

Modifier

Opération de suppression pour supprimer l’extension.

az vm extension delete [--ids]
                       [--name]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Exemples

Utilisez un nom et une extension de machine virtuelle pour supprimer une extension d’une machine virtuelle.

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

Supprimez des extensions avec des ID contenant la chaîne « MyExtension » d’une machine virtuelle.

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

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 --vm-extension-name -n

Nom de l’extension de machine virtuelle.

--no-wait

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

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--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. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vm=<name>de .

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

Modifier

Répertoriez les extensions attachées à une machine virtuelle.

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

Exemples

Répertorier les extensions jointes à une machine virtuelle nommée.

az vm extension list -g MyResourceGroup --vm-name MyVm

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

--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. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vm=<name>de .

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

Modifier

Définissez des extensions pour une machine virtuelle.

Obtenir les détails de l’extension à partir de az vm extension image list.

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

Exemples

Ajoutez un compte d’utilisateur à une machine virtuelle Linux.

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

Ajoutez une extension customScript à des machines virtuelles spécifiées par --ids.

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

Ajoutez une extension et activez la mise à niveau automatique par la plateforme s’il existe une version plus récente de l’extension disponible.

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

Paramètres obligatoires

--name -n

Nom de l’extension.

valeur de: az vm extension image list
--publisher

Nom de l’éditeur d’extension.

Paramètres facultatifs

--enable-auto-upgrade

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

valeurs acceptées: false, true
--extension-instance-name

Nom de l’instance d’extension, qui peut être personnalisé. Valeur par défaut : nom de l’extension.

--force-update

Forcez la mise à jour même si la configuration de l’extension n’a pas changé.

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

--no-auto-upgrade
Déprécié

L’option « --no-auto-upgrade » a été déconseillée et sera supprimée dans une prochaine version. Utilisez plutôt « --no-auto-upgrade-minor-version ».

Si elle est définie, le service d’extension ne sélectionne pas ou ne met pas automatiquement à niveau vers la dernière version mineure, même si l’extension est redéployée.

valeurs acceptées: false, true
valeur par défaut: False
--no-auto-upgrade-minor-version

Si elle est définie, le service d’extension ne sélectionne pas ou ne met pas automatiquement à niveau vers la dernière version mineure, même si l’extension est redéployée.

valeurs acceptées: false, true
valeur par défaut: False
--no-wait

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

valeur par défaut: False
--protected-settings

Paramètres protégés au format JSON pour les informations sensibles telles que les informations d’identification. Un chemin d’accès au fichier JSON est également accepté.

--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 d’extension au format JSON. Un chemin d’accès au fichier JSON est également accepté.

--subscription

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

--version

Version de l’extension. Pour épingler la version de l’extension à cette valeur, spécifiez --no-auto-upgrade-minor-version.

--vm-name

Nom de la machine virtuelle. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vm=<name>de .

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

Modifier

Affichez des informations sur les extensions attachées à une machine virtuelle.

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

Exemples

Utilisez le nom de la machine virtuelle et le nom de l’extension pour afficher les extensions attachées à une machine virtuelle.

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

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

--instance-view

Vue d’instance d’une extension de machine virtuelle.

valeur par défaut: False
--name -n

Nom de l’extension.

--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. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vm=<name>de .

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

Modifier

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

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

Exemples

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

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

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

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

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

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

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

Nom de l’extension.

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

Nom de la machine virtuelle. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vm=<name>de .

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.