Compartilhar via

az vm run-command

  • Referência

Gerenciar comandos de execução em uma 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

Nome Description Tipo Status
az vm run-command create

A operação para criar o comando de execução.

 Núcleo GA
az vm run-command delete

A operação para excluir o comando de execução.

 Núcleo GA
az vm run-command invoke

Execute um comando de execução específico em uma VM.

 Núcleo GA
az vm run-command list

Listar comandos de execução de uma VM ou de um local.

 Núcleo GA
az vm run-command show

Obter um comando de execução específico.

 Núcleo GA
az vm run-command update

A operação para atualizar o comando de execução.

 Núcleo GA
az vm run-command wait

Coloque a CLI em um estado de espera até que uma condição do comando res virtual-machine-run seja atendida.

 Núcleo GA

az vm run-command create

Editar

A operação para criar o comando de execução.

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]

Exemplos

Crie um comando de execução.

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"

Crie um comando de execução com o carregamento do fluxo de saída de script para o URI do SAS (blob de armazenamento do Azure).

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"

Parâmetros Exigidos

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

--vm-name

O nome 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 aceitos: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Especifique o blob de armazenamento do Azure em que o fluxo de erros 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 aguarde a conclusão da operação de execução prolongada.

Valor padrão: False
--output-blob-uri

Especifique o URI do SAS (blob de armazenamento do Azure) em que o fluxo de saída de script será carregado.

--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 executar como usuário. Ele será criptografado e não registrado.

--run-as-user

Por padrão, o processo de script é executado no usuário do sistema/raiz. 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

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

--timeout-in-seconds

O tempo limite em segundos para executar o comando de execução.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command delete

Editar

A operação para excluir o comando de execução.

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

Exemplos

Excluir um comando de execução.

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

Parâmetros Exigidos

--name --run-command-name

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valor padrão: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--vm-name

O nome da máquina virtual.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command invoke

Editar

Execute um comando de execução específico em uma VM.

az vm run-command show retorna informações úteis em cada comando de execução. Descubra as IDs de comando executar por meio de az vmss run-command list.

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

Exemplos

Instale o nginx em uma VM linux.

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

Execute o comando shell em uma VM linux com parâmetros.

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

Execute o script do PowerShell em uma VM do Windows com parâmetros. Script fornecido embutido. Tenha cuidado com aspas simples em 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'

Execute o script do PowerShell em uma VM do Windows com parâmetros. Script fornecido do arquivo.

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

Parâmetros Exigidos

--command-id

A ID do comando.

Valor de: az vm run-command list

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--name -n

O nome da Máquina Virtual. Você pode configurar o padrão usando az configure --defaults vm=<name>.

--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Valor padrão: False
--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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command list

Editar

Listar comandos de execução de uma VM ou de um local.

Você pode especificar "--resource-group" e "--vm-name" para obter todos os comandos de execução de uma máquina virtual. Ou você pode especificar "--location" para listar todos os comandos de execução disponíveis para uma assinatura em um local.

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

Exemplos

Listar comandos de execução em uma máquina virtual.

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

Liste todos os comandos de execução disponíveis para uma assinatura em um local.

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

Parâmetros Opcionais

--expand

A expressão de expansão a ser aplicada na operação.

--location -l

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

--resource-group -g

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

--vm-name

O nome da máquina virtual.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command show

Editar

Obter um comando de execução específico.

Você pode especificar "--resource-group", "--run-command-name" e "--vm-name" para obter o comando executar em uma máquina virtual. Ou você pode especificar "--command-id" e "--location" para obter um comando de execução para uma assinatura em um local.

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

Exemplos

Obtenha os comandos de execução em uma máquina virtual.

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

Obtenha um comando de execução específico para uma assinatura em um local.

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

Parâmetros Opcionais

--command-id

A ID do comando.

--expand
Preterido

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

A expressão de expansão a ser aplicada na operação.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--instance-view

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

Valor padrão: False
--location -l

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

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

--subscription

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

--vm-name

O nome da máquina virtual.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command update

Editar

A operação para atualizar o comando de execução.

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]

Exemplos

Atualize um comando de execução.

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"

Atualize um comando de execução com o carregamento do fluxo de saída de script para o URI do SAS (blob de armazenamento do Azure).

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"

Parâmetros Exigidos

--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 aceitos: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Especifique o blob de armazenamento do Azure em que o fluxo de erros de script será carregado.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--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 aguarde a conclusão da operação de execução prolongada.

Valor padrão: False
--output-blob-uri

Especifique o URI do SAS (blob de armazenamento do Azure) em que o fluxo de saída de script será carregado.

--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 executar como usuário. Ele será criptografado e não registrado.

--run-as-user

Por padrão, o processo de script é executado no usuário do sistema/raiz. 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

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

--timeout-in-seconds

O tempo limite em segundos para executar o comando de execução.

--vm-name

O nome da máquina virtual.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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

az vm run-command wait

Editar

Coloque a CLI em um estado de espera até que uma condição do comando res virtual-machine-run seja atendida.

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

Parâmetros Opcionais

--command-id

A ID do comando.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição atenda a uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--expand
Preterido

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

A expressão de expansão a ser aplicada na operação.

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--instance-view

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

Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--location -l

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

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

--subscription

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

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
--vm-name

O nome da máquina virtual.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

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

--verbose

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