az vm run-command

  • Référence

Gérer les commandes d’exécution sur une machine virtuelle.

Pour plus d'informations, consultez https://docs.microsoft.com/azure/virtual-machines/windows/run-command ou https://docs.microsoft.com/azure/virtual-machines/linux/run-command.

Commandes

Nom Description Type Statut
az vm run-command create

Opération de création de la commande d’exécution.

 Core GA
az vm run-command delete

Opération de suppression de la commande d’exécution.

 Core GA
az vm run-command invoke

Exécutez une commande d’exécution spécifique sur une machine virtuelle.

 Core GA
az vm run-command list

Répertoriez les commandes d’exécution à partir d’une machine virtuelle ou d’un emplacement.

 Core GA
az vm run-command show

Obtenir une commande d’exécution spécifique.

 Core GA
az vm run-command update

Opération de mise à jour de la commande d’exécution.

 Core GA
az vm run-command wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de la commande res virtual-machine-run-command soit remplie.

 Core GA

az vm run-command create

Modifier

Opération de création de la commande d’exécution.

az vm run-command create --name
                         --resource-group
                         --vm-name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--tags]
                         [--timeout-in-seconds]

Exemples

Créez une commande d’exécution.

az vm run-command create --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Créez une commande d’exécution avec le chargement du flux de sortie de script vers l’objet blob de stockage Azure (URI SAS).

az vm run-command create --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

Paramètres obligatoires

--name --run-command-name

Nom de la commande d’exécution de la 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.

Paramètres facultatifs

--async-execution

facultatif. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas que le script se termine.

valeurs acceptées: false, true
--command-id

Spécifiez un commandId de script intégré prédéfini.

--error-blob-uri

Spécifiez l’objet blob de stockage Azure dans lequel le flux d’erreur de script sera chargé.

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

--no-wait

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

valeur par défaut: False
--output-blob-uri

Spécifiez l’objet blob de stockage Azure (URI SAS) dans lequel le flux de sortie de script sera chargé.

--parameters

Paramètres utilisés par le script.

Utilisation : --parameters arg1=XX arg2=XX.

--protected-parameters

Paramètres utilisés par le script.

Utilisation : --protected-parameters credentials=somefoo secret=somebar.

--run-as-password

Mot de passe si nécessaire pour utiliser le paramètre d’exécution en tant qu’utilisateur. Il sera chiffré et non journalisé.

--run-as-user

Par défaut, le processus de script s’exécute sous l’utilisateur système/racine. Spécifiez un utilisateur personnalisé pour héberger le processus.

--script

Spécifiez le contenu du script à exécuter sur la machine virtuelle.

--script-uri

Spécifiez l’emplacement de téléchargement du script.

--tags

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

--timeout-in-seconds

Délai d’expiration en secondes pour exécuter la commande d’exécution.

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 run-command delete

Modifier

Opération de suppression de la commande d’exécution.

az vm run-command delete --name
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]
                         [--vm-name]
                         [--yes]

Exemples

Supprimez une commande d’exécution.

az vm run-command delete --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

Paramètres obligatoires

--name --run-command-name

Nom de la commande d’exécution de la machine virtuelle.

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

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

--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 vm run-command invoke

Modifier

Exécutez une commande d’exécution spécifique sur une machine virtuelle.

az vm run-command show retourne des informations utiles sur chaque commande d’exécution. Découvrez l’ID de commande Run via az vmss run-command list.

az vm run-command invoke --command-id
                         [--ids]
                         [--name]
                         [--no-wait]
                         [--parameters]
                         [--resource-group]
                         [--scripts]
                         [--subscription]

Exemples

Installez nginx sur une machine virtuelle Linux.

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts "sudo apt-get update && sudo apt-get install -y nginx"

Exécutez la commande shell sur une machine virtuelle Linux avec des paramètres.

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts 'echo $1 $2' --parameters hello world

Exécutez un script PowerShell sur une machine virtuelle Windows avec des paramètres. Script fourni en ligne. Soyez wary of single-quoting in CMD.exe.

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group  \
    --scripts 'param([string]$arg1,[string]$arg2)' \
    'Write-Host This is a sample script with parameters $arg1 and $arg2' \
    --parameters 'arg1=somefoo' 'arg2=somebar'

Exécutez un script PowerShell sur une machine virtuelle Windows avec des paramètres. Script fourni à partir du fichier.

# script.ps1
#   param(
#       [string]$arg1,
#       [string]$arg2
#   )
#   Write-Host This is a sample script with parameters $arg1 and $arg2

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar"

Paramètres obligatoires

--command-id

ID de commande.

valeur de: az vm run-command list

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

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

--no-wait

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

valeur par défaut: False
--parameters

Paramètres séparés par l’espace au format « [name=]value ».

--resource-group -g

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

--scripts

Lignes de script séparées par l’espace. Utilisez @{file} pour charger le script à partir d’un fichier.

--subscription

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

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 run-command list

Modifier

Répertoriez les commandes d’exécution à partir d’une machine virtuelle ou d’un emplacement.

Vous pouvez spécifier « --resource-group » et « --vm-name » pour obtenir toutes les commandes d’exécution d’une machine virtuelle. Vous pouvez également spécifier « --location » pour répertorier toutes les commandes d’exécution disponibles pour un abonnement dans un emplacement.

az vm run-command list [--expand]
                       [--location]
                       [--resource-group]
                       [--vm-name]

Exemples

Répertoriez les commandes d’exécution dans une machine virtuelle.

az vm run-command list --resource-group "myResourceGroup" --vm-name "myVM"

Répertoriez toutes les commandes d’exécution disponibles pour un abonnement dans un emplacement.

az vm run-command list --location "SoutheastAsia"

Paramètres facultatifs

--expand

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

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

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

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 run-command show

Modifier

Obtenir une commande d’exécution spécifique.

Vous pouvez spécifier « --resource-group », « --run-command-name » et « --vm-name » pour obtenir la commande d’exécution dans une machine virtuelle. Vous pouvez également spécifier « --command-id » et « --location » pour obtenir la commande d’exécution d’un abonnement dans un emplacement.

az vm run-command show [--command-id]
                       [--ids]
                       [--instance-view]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

Exemples

Obtenez les commandes d’exécution dans une machine virtuelle.

az vm run-command show --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

Obtenir une commande d’exécution spécifique pour un abonnement dans un emplacement.

az vm run-command show --command-id "RunPowerShellScript" --location "SoutheastAsia"

Paramètres facultatifs

--command-id

ID de commande.

--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 commande d’exécution.

valeur par défaut: False
--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 --run-command-name

Nom de la commande d’exécution de la 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.

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 run-command update

Modifier

Opération de mise à jour de la commande d’exécution.

az vm run-command update --name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--ids]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--resource-group]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--subscription]
                         [--tags]
                         [--timeout-in-seconds]
                         [--vm-name]

Exemples

Mettez à jour une commande d’exécution.

az vm run-command update --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

Mettez à jour une commande d’exécution avec le chargement du flux de sortie de script vers l’objet blob de stockage Azure (URI SAS).

az vm run-command update --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

Paramètres obligatoires

--name --run-command-name

Nom de la commande d’exécution de la machine virtuelle.

Paramètres facultatifs

--async-execution

facultatif. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas que le script se termine.

valeurs acceptées: false, true
--command-id

Spécifiez un commandId de script intégré prédéfini.

--error-blob-uri

Spécifiez l’objet blob de stockage Azure dans lequel le flux d’erreur de script sera chargé.

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

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

--no-wait

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

valeur par défaut: False
--output-blob-uri

Spécifiez l’objet blob de stockage Azure (URI SAS) dans lequel le flux de sortie de script sera chargé.

--parameters

Paramètres utilisés par le script.

Utilisation : --parameters arg1=XX arg2=XX.

--protected-parameters

Paramètres utilisés par le script.

Utilisation : --protected-parameters credentials=somefoo secret=somebar.

--resource-group -g

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

--run-as-password

Mot de passe si nécessaire pour utiliser le paramètre d’exécution en tant qu’utilisateur. Il sera chiffré et non journalisé.

--run-as-user

Par défaut, le processus de script s’exécute sous l’utilisateur système/racine. Spécifiez un utilisateur personnalisé pour héberger le processus.

--script

Spécifiez le contenu du script à exécuter sur la machine virtuelle.

--script-uri

Spécifiez l’emplacement de téléchargement du script.

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

--timeout-in-seconds

Délai d’expiration en secondes pour exécuter la commande d’exécution.

--vm-name

Nom de la machine virtuelle.

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 run-command wait

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de la commande res virtual-machine-run-command soit remplie.

az vm run-command wait [--command-id]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--instance-view]
                       [--interval]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]
                       [--vm-name]

Paramètres facultatifs

--command-id

ID de commande.

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

--instance-view

Vue d’instance d’une commande d’exécution.

valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--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 --run-command-name

Nom de la commande d’exécution de la 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.

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

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.