Partilhar via

az vmss run-command

  • Referência

Gerencie comandos de execução em um Conjunto de Dimensionamento de Máquina Virtual.

Para obter mais informações, consulte https://learn.microsoft.com/azure/virtual-machines/windows/run-command ou https://learn.microsoft.com/azure/virtual-machines/linux/run-command.

Comandos

Name Description Tipo Status
az vmss run-command create

A operação para criar o comando VM VM run.

 Núcleo GA
az vmss run-command delete

A operação para excluir o comando run.

 Núcleo GA
az vmss run-command invoke

Execute um comando run específico em uma instância do Conjunto de Escala de Máquina Virtual.

 Núcleo GA
az vmss run-command list

A operação para obter todos os comandos de execução de uma instância no Virtual Machine Scaleset.

 Núcleo GA
az vmss run-command show

A operação para obter o comando VMSS run.

 Núcleo GA
az vmss run-command update

A operação para atualizar o comando VMSS run.

 Núcleo GA

az vmss run-command create

Editar

A operação para criar o comando VM VM run.

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]

Exemplos

Criar comando VMSS run.

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"

Parâmetros Obrigatórios

--instance-id

O ID da instância da máquina virtual.

--name --run-command-name

O nome do comando de execução da máquina virtual.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--vmss-name

O nome do conjunto de escala de VM.

Parâmetros Opcionais

--async-execution

Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.

Valores aceites: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Uri (sem SAS) para um blob de acréscimo onde o fluxo de erro de script será carregado.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--output-blob-uri

Uri (sem SAS) para um blob de acréscimo onde a saída do script será carregada.

--parameters

Os parâmetros usados pelo script.

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

--protected-parameters

Os parâmetros usados pelo script.

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

--run-as-password

Senha se necessário para usar o parâmetro run-as-user. Ele será criptografado e não registrado.

--run-as-user

Por padrão, o processo de script é executado em system/root user. Especifique o usuário personalizado para hospedar o processo.

--script

Especifique o conteúdo do script a ser executado na VM.

--script-uri

Especifique o local de download do script.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--timeout-in-seconds

O tempo limite em segundos para executar o comando run.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az vmss run-command delete

Editar

A operação para excluir o comando run.

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

Exemplos

A operação para excluir o comando VMSS run ..

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

Parâmetros Obrigatórios

--name --run-command-name

O nome do comando de execução da máquina virtual.

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--instance-id

O ID da instância da máquina virtual.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--vmss-name

O nome do conjunto de escala de VM.

--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az vmss run-command invoke

Editar

Execute um comando run específico em uma instância do Conjunto de Escala de Máquina Virtual.

az vmss run-command show retorna informações úteis sobre cada comando de execução. Descubra Run command-id's via az vmss run-command list.

az vmss run-command invoke --command-id
                           [--ids]
                           [--instance-id]
                           [--name]
                           [--parameters]
                           [--resource-group]
                           [--scripts]
                           [--subscription]

Exemplos

Instale o nginx em uma instância do 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"

Invoque um comando de execução com parâmetros em uma instância do VMSS.

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

Invoque o comando em todas as instâncias do VMSS usando as IDs de recurso da instância do VMSS. Nota: "@-" expande-se para 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 @-

Execute o script powershell em uma instância do Windows VMSS com parâmetros. Script fornecido em linha. Desconfie de citações únicas em 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

Execute o script powershell em uma instância do Windows VMSS com parâmetros. Script fornecido a partir do arquivo.

# 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

Parâmetros Obrigatórios

--command-id

A id do comando.

Valor de: az vmss run-command list

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--instance-id

Dimensione o ID da instância da VM do conjunto.

--name -n

Nome do conjunto de escalas. Você pode configurar o padrão usando az configure --defaults vmss=<name>.

--parameters

Parâmetros separados por espaço no formato '[name=]value'.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--scripts

Linhas de script separadas por espaço. Use @{file} para carregar o script de um arquivo.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az vmss run-command list

Editar

A operação para obter todos os comandos de execução de uma instância no Virtual Machine Scaleset.

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

Exemplos

Listar comandos de execução na instância do Vmss.

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

Parâmetros Obrigatórios

--instance-id

O ID da instância da máquina virtual.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--vmss-name

O nome do conjunto de escala de VM.

Parâmetros Opcionais

--expand

A expressão expand a ser aplicada na operação.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az vmss run-command show

Editar

A operação para obter o comando VMSS run.

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

Exemplos

Obtenha comandos de execução do VMSS.

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

Parâmetros Obrigatórios

--name --run-command-name

O nome do comando de execução da máquina virtual.

Parâmetros Opcionais

--expand
Preterido

O argumento 'expandir' foi preterido e será removido em uma versão futura.

A expressão expand a ser aplicada na operação.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--instance-id

O ID da instância da máquina virtual.

--instance-view

A exibição de instância de um comando de execução.

Default value: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--vmss-name

O nome do conjunto de escala de VM.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az vmss run-command update

Editar

A operação para atualizar o comando VMSS run.

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]

Exemplos

Atualizar comando VMSS run.

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"

Parâmetros Obrigatórios

--name --run-command-name

O nome do comando de execução da máquina virtual.

Parâmetros Opcionais

--async-execution

Opcional. Se definido como true, o provisionamento será concluído assim que o script for iniciado e não aguardará a conclusão do script.

Valores aceites: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Uri (sem SAS) para um blob de acréscimo onde o fluxo de erro de script será carregado.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--instance-id

O ID da instância da máquina virtual.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--output-blob-uri

Uri (sem SAS) para um blob de acréscimo onde a saída do script será carregada.

--parameters

Os parâmetros usados pelo script.

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

--protected-parameters

Os parâmetros usados pelo script.

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

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--run-as-password

Senha se necessário para usar o parâmetro run-as-user. Ele será criptografado e não registrado.

--run-as-user

Por padrão, o processo de script é executado em system/root user. Especifique o usuário personalizado para hospedar o processo.

--script

Especifique o conteúdo do script a ser executado na VM.

--script-uri

Especifique o local de download do script.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--timeout-in-seconds

O tempo limite em segundos para executar o comando run.

--vmss-name

O nome do conjunto de escala de VM.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.