Partilhar via


az vm run-command

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

Para obter mais informações, consulte https://v4.hkg1.meaqua.org/azure/virtual-machines/windows/run-command ou https://v4.hkg1.meaqua.org/azure/virtual-machines/linux/run-command.

Comandos

Name Description Tipo Status
az vm run-command create

A operação para criar o comando run.

Core disponibilidade geral
az vm run-command delete

A operação para excluir o comando run.

Core disponibilidade geral
az vm run-command invoke

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

Core disponibilidade geral
az vm run-command list

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

Core disponibilidade geral
az vm run-command show

Obter comando de execução específico.

Core disponibilidade geral
az vm run-command update

A operação para atualizar o comando run.

Core disponibilidade geral
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.

Core disponibilidade geral

az vm run-command create

A operação para criar o comando run.

az vm run-command create --name --run-command-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 blob de armazenamento do 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"

Parâmetros Obrigatórios

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--async-execution

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

Propriedade Valor
Valores aceites: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Especifique o blob de armazenamento do Azure onde o fluxo de erro de script será carregado.

--location -l

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

Propriedade Valor
Default value: False
--output-blob-uri

Especifique o blob de armazenamento do Azure (URI SAS) onde o fluxo de saída do 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 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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Default value: False

az vm run-command delete

A operação para excluir o comando run.

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

Exemplos

Exclua um comando de execução.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --run-command-name -n

O nome do VirtualMachineRunCommand.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

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

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--vm-name

O nome do VirtualMachine.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az vm run-command invoke

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

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

Exemplos

Instale 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 powershell em uma VM do Windows com parâmetros. Script fornecido em linha. Desconfie de citações únicas 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 powershell em uma VM do Windows 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 vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar"

Parâmetros Obrigatórios

--command-id

A id do comando.

Propriedade Valor
Valor de: az vm run-command list

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

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

Propriedade Valor
Default value: 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>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az vm run-command list

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--expand

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

--location -l

Location. 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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Propriedade Valor
Default value: False

az vm run-command show

Obter comando de execução específico.

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

az vm run-command show [--command-id]
                       [--ids]
                       [--instance-view]
                       [--location]
                       [--name --run-command-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"

Obter 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--command-id

A id do comando.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--instance-view

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

Propriedade Valor
Default value: False
--location -l

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--vm-name

O nome da máquina virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

az vm run-command update

A operação para atualizar o comando run.

az vm run-command update --name --run-command-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 run com o carregamento do fluxo de saída de script para o blob de armazenamento do 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"

Parâmetros Obrigatórios

--name --run-command-name

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--async-execution

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

Propriedade Valor
Valores aceites: false, true
--command-id

Especifique um commandId de script interno predefinido.

--error-blob-uri

Especifique o blob de armazenamento do Azure 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 que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--location -l

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

Propriedade Valor
Default value: False
--output-blob-uri

Especifique o blob de armazenamento do Azure (URI SAS) onde o fluxo de saída do 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>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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.

--vm-name

O nome da máquina virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False

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.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--command-id

A id do comando.

--created

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--instance-view

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

Propriedade Valor
Default value: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--location -l

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--updated

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--vm-name

O nome da máquina virtual.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

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

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

--verbose

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

Propriedade Valor
Default value: False