Executar scripts em uma VM Windows usando a ação Executar Comandos

O recurso Executar Comando usa o agente da máquina virtual (VM) para executar scripts do PowerShell dentro de uma VM Windows do Azure. Use esses scripts para o gerenciamento geral de máquinas ou aplicativos. Eles podem ajudá-lo a diagnosticar e corrigir rapidamente problemas de rede e acesso à VM e colocar a VM em um bom estado.

Benefícios

Acesse as máquinas virtuais de várias maneiras. O recurso Executar Comando pode executar scripts nas máquinas virtuais remotamente usando o agente de VM. Use Executar Comando por meio do portal do Azure, da API REST, ou do PowerShell para VMs do Windows.

Esse recurso é útil em todos os cenários em que você deseja executar um script em uma máquina virtual. É uma das únicas maneiras de solucionar problemas e corrigir uma máquina virtual que não tem a porta RDP ou SSH aberta devido à configuração imprópria da rede ou do usuário administrativo.

Pré-requisitos

Sistemas Operacionais Windows com Suporte

Restrições

As seguintes restrições se aplicam ao usar o recurso Executar Comando:

• A saída está limitada aos últimos 4.096 bytes.
• O tempo mínimo para executar um script é de cerca de 20 segundos.
• Os scripts são executados como sistema no Windows.
• É possível executar um script por vez.
• Scripts que solicitam informações (modo interativo) não têm suporte.
• Não é possível cancelar um script em execução.
• O tempo máximo que um script pode ser executado é 90 minutos. Depois disso, ele atingirá o tempo limite.
• A conectividade de saída da VM é necessária para retornar os resultados do script.
• Não é recomendável executar um script que causará uma parada ou atualização do Agente de VM. Isso pode deixar a extensão no estado Em transição, levando a um tempo limite.

Comandos disponíveis

Esta tabela mostra a lista de comandos disponíveis para VMs Windows. Use o comando RunPowerShellScript para executar qualquer script personalizado que desejar. Quando você estiver usando a CLI do Azure ou o PowerShell para executar um comando, o valor fornecido para o parâmetro --command-id ou -CommandId deverá ser um dos seguintes valores listados. Quando especifica um valor que não é um comando disponível, recebe este erro:

The entity was not found in this Azure location

Comandos disponíveis

Limitando o acesso ao recurso Executar Comando

Listar os comandos de execução ou mostrar os detalhes de um comando requer a permissão Microsoft.Compute/locations/runCommands/read no Nível de Assinatura. A função Leitor interna e os níveis superiores têm essa permissão.

A execução de um comando requer a permissão Microsoft.Compute/virtualMachines/runCommand/action. A função Colaborador de Máquina Virtual e os níveis superiores têm essa permissão.

Use uma das funções internas ou crie uma função personalizada para usar o recurso Executar Comando.

Usando comandos de execução

Invoke-AzVMRunCommand -ResourceGroupName '<myResourceGroup>' -Name '<myVMName>' -CommandId 'RunPowerShellScript' -ScriptPath '<pathToScript>' -Parameter @{"arg1" = "var1";"arg2" = "var2"}

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

Solução de problemas do Windows para Ação Executar Comando

Ao solucionar problemas da ação executar comando para ambientes do Windows, confira o arquivo de log RunCommandExtension normalmente localizado no seguinte diretório: C:\WindowsAzure\Logs\Plugins\Microsoft.CPlat.Core.RunCommandWindows\<version>\RunCommandExtension.log, para obter mais detalhes.

Problemas conhecidos

• A Extensão da Ação Executar Comando pode não ser executada no ambiente Windows, se o comando contiver caracteres reservados. Por exemplo:

  Se o símbolo & for passado no parâmetro do comando, como o script do PowerShell abaixo, ele poderá falhar.

  $paramm='abc&jj'
  Invoke-AzVMRunCommand -ResourceGroupName AzureCloudService1 -Name test -CommandId 'RunPowerShellScript' -ScriptPath     C:\data\228332902\PostAppConfig.ps1 -Parameter @{"Prefix" = $paramm}
  

  Use o caractere ^ para sair do & no argumento, como $paramm='abc^&jj'

• A extensão Executar Comando também pode não ser executada, se o comando a ser executado contiver "\n" no caminho, pois ela será tratada como uma nova linha. Por exemplo, C:\Windows\notepad.exe contém o \n no caminho do arquivo. Substitua \n por \N no caminho.

• Verifique se você não tem nenhuma configuração personalizada na chave do Registro HKLM\SOFTWARE\Microsoft\Command Processor\AutoRun(detalhada aqui). Isso pode ser disparado durante a instalação da Extensão RunCommand ou habilitar fases e causar um erro como 'XYZ não é reconhecido como um comando interno ou externo, programa operável ou arquivo em lotes'.

Remoção da Ação Executar Comando

Se precisar remover a extensão do Windows da ação Executar Comando, confira as etapas abaixo para o Azure PowerShell e a CLI:

Substitua rgname e vmname pelo nome do grupo de recursos relevante e pelo nome da máquina virtual nos exemplos de remoção a seguir.

 Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RemoveRunCommandWindowsExtension'

az vm run-command invoke  --command-id RemoveRunCommandWindowsExtension --name vmname -g rgname

Próximas etapas

Para conhecer outras maneiras de executar scripts e comandos remotamente em sua VM, consulte Executar scripts na VM do Windows.