az vmss run-command

  • Référence

Gérer les commandes d’exécution sur un groupe de machines virtuelles identiques.

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 État
az vmss run-command create

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

 Core GA
az vmss run-command delete

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

 Core GA
az vmss run-command invoke

Exécutez une commande d’exécution spécifique sur une instance de groupe de machines virtuelles identiques.

 Core GA
az vmss run-command list

Opération permettant d’obtenir toutes les commandes d’exécution d’une instance dans virtual Machine Scaleset.

 Core GA
az vmss run-command show

Opération permettant d’obtenir la commande d’exécution vmSS.

 Core GA
az vmss run-command update

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

 Core GA

az vmss run-command create

Modifier

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

az vmss run-command create --instance-id
                           --name
                           --resource-group
                           --vmss-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éer une commande d’exécution VMSS.

az vmss run-command create --resource-group "myResourceGroup" --instance-id "0" --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" --vmss-name "myVMSS"

Paramètres obligatoires

--instance-id

ID d’instance de la machine virtuelle.

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

--vmss-name

Nom du groupe de machines virtuelles identiques.

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

Uri (sans SAP) vers un objet blob d’ajout où 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

Uri (sans SAP) vers un objet blob d’ajout où la sortie du script sera chargée.

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

Modifier

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

az vmss run-command delete --name
                           [--ids]
                           [--instance-id]
                           [--no-wait]
                           [--resource-group]
                           [--subscription]
                           [--vmss-name]
                           [--yes]

Exemples

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

az vmss run-command delete --resource-group "myResourceGroup" --instance-id "0" --run-command-name "myRunCommand" --vmss-name "myVMSS"

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

--instance-id

ID d’instance de la 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.

--vmss-name

Nom du groupe de machines virtuelles identiques.

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

Modifier

Exécutez une commande d’exécution spécifique sur une instance de groupe de machines virtuelles identiques.

az vmss 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 vmss run-command invoke --command-id
                           [--ids]
                           [--instance-id]
                           [--name]
                           [--parameters]
                           [--resource-group]
                           [--scripts]
                           [--subscription]

Exemples

Installez nginx sur une instance VMSS.

az vmss run-command invoke -g MyResourceGroup -n MyVMSS --command-id RunShellScript \ --instance-id 0 --scripts "sudo apt-get update && sudo apt-get install -y nginx"

Appelez une commande d’exécution avec des paramètres sur une instance VMSS.

az vmss run-command invoke -g MyResourceGroup -n MyVMSS --command-id RunShellScript \ --instance-id 4 --scripts 'echo $1 $2' --parameters hello world

Appelez la commande sur toutes les instances VMSS à l’aide des ID de ressource d’instance VMSS. Remarque : « @- » s’étend sur stdin.

az vmss list-instances -n MyVMSS -g my-rg --query "[].id" --output tsv | \
az vmss run-command invoke --scripts 'echo $1 $2' --parameters hello world  \
    --command-id RunShellScript --ids @-

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

az vmss 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' --instance-id 2

Exécutez un script PowerShell sur une instance VMSS 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 vmss run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar" --instance-id 5

Paramètres obligatoires

--command-id

ID de commande.

Valeur de: az vmss 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 ».

--instance-id

ID d’instance de machine virtuelle de groupe identique.

--name -n

Nom du groupe identique. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults vmss=<name>de .

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

Modifier

Opération permettant d’obtenir toutes les commandes d’exécution d’une instance dans virtual Machine Scaleset.

az vmss run-command list --instance-id
                         --resource-group
                         --vmss-name
                         [--expand]

Exemples

Répertoriez les commandes d’exécution dans l’instance de Vmss.

az vmss run-command list --resource-group "myResourceGroup" --vmss-name "myVMSS" --instance-id "0"

Paramètres obligatoires

--instance-id

ID d’instance 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>.

--vmss-name

Nom du groupe de machines virtuelles identiques.

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

Modifier

Opération permettant d’obtenir la commande d’exécution vmSS.

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

Exemples

Obtenir les commandes d’exécution de VMSS.

az vmss run-command show --instance-id "0" --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vmss-name "myVMSS"

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

--instance-id

ID d’instance de la machine virtuelle.

--instance-view

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

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.

--vmss-name

Nom du groupe de machines virtuelles identiques.

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

Modifier

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

az vmss run-command update --name
                           [--async-execution {false, true}]
                           [--command-id]
                           [--error-blob-uri]
                           [--ids]
                           [--instance-id]
                           [--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]
                           [--vmss-name]

Exemples

Mettre à jour la commande d’exécution de VMSS.

az vmss run-command update --resource-group "myResourceGroup" --instance-id "0" --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" --vmss-name "myVMSS"

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

Uri (sans SAP) vers un objet blob d’ajout où 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 ».

--instance-id

ID d’instance de la machine virtuelle.

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

Uri (sans SAP) vers un objet blob d’ajout où la sortie du script sera chargée.

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

--vmss-name

Nom du groupe de machines virtuelles identiques.

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.