Share via

Executar scripts na VM Windows com os Comandos Executar geridos

  • Artigo

Aplica-se a: ✔️ VMs ✔️ do Windows Conjuntos de escala flexíveis

Importante

O Comando de Execução Gerenciada está atualmente disponível na CLI do Azure, PowerShell e API no momento. A funcionalidade do portal estará disponível em breve.

O recurso Executar Comando usa o agente de máquina virtual (VM) para executar scripts em uma VM do Windows do Azure. Pode utilizar estes scripts para a gestão geral de computadores ou aplicações. Eles podem ajudá-lo a diagnosticar e corrigir rapidamente problemas de acesso à VM e de rede e fazer com que a VM volte a um bom estado.

O Run Command gerenciado atualizado usa o mesmo canal de agente de VM para executar scripts e fornece os seguintes aprimoramentos em relação ao Run Command orientado para a ação original:

  • Suporte para o Comando Executar atualizado através do modelo de implementação do ARM
  • Execução paralela de vários scripts
  • Execução sequencial de scripts
  • Tempo limite excedido para o script especificado pelo utilizador
  • Suporte para scripts de execução prolongada (horas/dias)
  • Transmitir segredos (parâmetros, palavras-passe) de forma segura

Pré-requisitos

Suportado pelo sistema operacional Windows

SO Windows x64
Windows 10 Suportado
Windows 11 Suportado
Windows Server 2008 SP2 Suportado
Windows Server 2008 R2 Suportado
Windows Server 2012 Suportado
Windows Server 2012 R2 Suportado
Windows Server 2016 Suportado
Núcleo do Windows Server 2016 Suportado
Windows Server 2019 Suportado
Núcleo do Windows Server 2019 Suportado
Windows Server 2022 Suportado
Núcleo do Windows Server 2022 Suportado

Limitar o acesso ao Comando Executar

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

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

Você pode usar uma das funções internas ou criar uma função personalizada para usar o Comando Executar.

CLI do Azure

Os exemplos a seguir usam az vm run-command para executar shell script em uma VM do Windows Azure.

Executar um script com a VM

Este comando entregará o script à VM, executá-lo-á e devolverá a saída capturada.

az vm run-command create --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --script "Write-Host Hello World!"

Listar todos os recursos RunCommand implantados em uma VM

Este comando retornará uma lista completa de Comandos de Execução implantados anteriormente, juntamente com suas propriedades.

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

Obter status e resultados de execução

Este comando recuperará o progresso da execução atual, incluindo a saída mais recente, a hora de início/fim, o código de saída e o estado terminal da execução.

az vm run-command show --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --expand instanceView

Nota

Os campos de saída e erro estão instanceView limitados aos últimos 4KB. Se você quiser acessar a saída completa e o erro, você tem a opção de encaminhar os dados de saída e erro para o armazenamento de blobs de acréscimo usando -outputBlobUri e -errorBlobUri parâmetros durante a execução Run Command usando Set-AzVMRunCommand ou Set-AzVMssRunCommand.

Excluir recurso RunCommand da VM

Remova o recurso RunCommand implantado anteriormente na VM. Se a execução do script ainda estiver em andamento, a execução será encerrada.

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

PowerShell

Executar um script com a VM

Este comando entregará o script à VM, executá-lo-á e devolverá a saída capturada.

Set-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -Location "EastUS" -RunCommandName "RunCommandName" –SourceScript "echo Hello World!"

Executar um script na VM usando o parâmetro SourceScriptUri

OutputBlobUri e ErrorBlobUri são parâmetros opcionais.

Set-AzVMRunCommand -ResourceGroupName -VMName -RunCommandName -SourceScriptUri “< SAS URI of a storage blob with read access or public URI>" -OutputBlobUri “< SAS URI of a storage append blob with read, add, create, write access>” -ErrorBlobUri “< SAS URI of a storage append blob with read, add, create, write access>”

Listar todos os recursos RunCommand implantados em uma VM

Este comando retornará uma lista completa de Comandos de Execução implantados anteriormente, juntamente com suas propriedades.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM"

Obter status e resultados de execução

Este comando recuperará o progresso da execução atual, incluindo a saída mais recente, a hora de início/fim, o código de saída e o estado terminal da execução.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName" -Expand InstanceView

Criar ou atualizar o comando Executar em uma VM usando SourceScriptUri (URL SAS do blob de armazenamento)

Criar ou atualizar o Comando Executar em uma VM do Windows usando uma URL SAS de um blob de armazenamento que contém um script do PowerShell. SourceScriptUri pode ser o URL SAS completo de um blob de armazenamento ou o URL público.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

Nota

A URL SAS deve fornecer acesso de leitura ao blob. Um tempo de expiração de 24 horas é sugerido para o URL SAS. As URLs SAS podem ser geradas no portal do Azure usando as opções do blob ou o token SAS usando New-AzStorageBlobSASTokeno . Se estiver gerando um token SAS usando New-AzStorageBlobSASTokeno , seu URL SAS = "URL de blob base" + "?" + "Token SAS de New-AzStorageBlobSASToken"

Obter uma exibição de instância de comando de execução para uma VM depois de criar ou atualizar o comando de execução

Obtenha um comando Run for VM com exibição de instância. Instance View contém o estado de execução do comando run (Succeeded, Failed, etc.), código de saída, saída padrão e erro padrão gerado pela execução do script usando Run Command. Um ExitCode diferente de zero indica uma execução malsucedida.

$x = Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Expand InstanceView
$x.InstanceView

Exemplo de saída

ExecutionState   : Succeeded
ExecutionMessage :
ExitCode         : 0
Output           :   
output       : uid=0(root) gid=0(root) groups=0(root)
                   HelloWorld

Error            :
StartTime        : 10/27/2022 9:10:52 PM
EndTime          : 10/27/2022 9:10:55 PM
Statuses         :

InstanceView.ExecutionState: Status do script Run Command do usuário. Consulte esse estado para saber se o script foi bem-sucedido ou não. ProvisioningState: Status do provisionamento de extensão geral de ponta a ponta (se a plataforma de extensão foi capaz de acionar o script Run Command ou não).

Criar ou atualizar o Run Command em uma VM usando ScriptLocalPath (arquivo de script local)

Criar ou atualizar o Comando Executar em uma VM usando um arquivo de script local que está na máquina cliente onde o cmdlet é executado.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1"

Criar ou atualizar o Comando Executar em uma VM usando SourceScript (texto de script)

Criar ou atualizar Run Command em uma VM passando o conteúdo do script diretamente para o parâmetro -SourceScript. Use ; para separar vários comandos

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld"

Criar ou atualizar o Run Command em uma VM usando SourceCommandId

Crie ou atualize o Run Command em uma VM usando commandId pré-existente. Os commandIds disponíveis podem ser recuperados usando Get-AzVMRunCommandDocument.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate

Criar ou atualizar Executar Comando em uma VM usando OutputBlobUri, ErrorBlobUri para transmitir saída padrão e mensagens de erro padrão para saída e erro Acrescentar blobs

Crie ou atualize o Comando Executar em uma VM e transmita mensagens de saída padrão e de erro padrão para blobs de saída e erro Anexe.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri <OutPutBlobUrI> -ErrorBlobUri "ErrorBlobUri

Nota

Os blobs de saída e de erro devem ser do tipo AppendBlob e suas URLs SAS devem fornecer acesso de leitura, acréscimo, criação e gravação ao blob. Um tempo de expiração de 24 horas é sugerido para o URL SAS. Se o blob de saída ou de erro não existir, um blob do tipo AppendBlob será criado. As URLs SAS podem ser geradas no portal do Azure usando as opções do blob ou o token SAS usando New-AzStorageBlobSASTokeno .

Criar ou atualizar Run Command em uma VM como um usuário diferente usando os parâmetros RunAsUser e RunAsPassword

Crie ou atualize o Comando Executar em uma VM como um usuário diferente usando RunAsUser e RunAsPassword parâmetros. Para que o RunAs funcione corretamente, entre em contato com o administrador da VM e verifique se o usuário foi adicionado à VM, o usuário tem acesso aos recursos acessados pelo comando Run (diretórios, arquivos, rede, etc.) e, no caso da VM do Windows, o serviço 'Logon secundário' está sendo executado na VM.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword

Criar ou atualizar o comando Executar em um recurso de conjuntos de escala de máquina virtual usando SourceScriptUri (URL SAS do blob de armazenamento)

Criar ou atualizar o Comando Executar em um recurso Conjuntos de Escala de Máquina Virtual do Windows usando uma URL SAS de um blob de armazenamento que contém um script do PowerShell.

Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

Nota

A URL SAS deve fornecer acesso de leitura ao blob. Sugere-se um tempo de expiração de 24 horas para o URL SAS. As URLs SAS podem ser geradas no portal do Azure usando as opções do blob ou o token SAS usando New-AzStorageBlobSASTokeno . Se estiver gerando o token SAS usando New-AzStorageBlobSASTokeno , o formato de URL SAS é: URL de blob base + "?" + o token SAS de New-AzStorageBlobSASToken.

Criar ou atualizar o Run Command em uma instância de VM usando os parâmetros Parameter e ProtectedParameter (Public e Protected Parameters to script)

Use ProtectedParameter para passar quaisquer entradas confidenciais para o script, como senhas, chaves, etc.

$PublicParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam1';value='publicParam1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam2';value='publicParam2value'})

$ProtectedParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret1';value='secret1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret2';value='secret2value'})

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -Parameter $PublicParametersArray -ProtectedParameter $ProtectedParametersArray

  • Windows: Parâmetros e ProtectedParameters são passados para script como argumentos são passados para script e executados desta forma - myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value

  • Linux: Parâmetros nomeados e seus valores são definidos como configuração de ambiente, que deve ser acessível dentro do script .sh. Para argumentos Nameless, passe uma cadeia de caracteres vazia para name input. Argumentos sem nome são passados para o script e executados assim - myscript.sh publicParam1value publicParam2value secret1value secret2value

Excluir recurso RunCommand da VM

Remova o recurso RunCommand implantado anteriormente na VM. Se a execução do script ainda estiver em andamento, a execução será encerrada.

Remove-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName"

API REST

Para implantar um novo Run Command, execute um PUT na VM diretamente e especifique um nome exclusivo para a instância Run Command.

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

{ 
"location": "<location>", 
"properties": { 
    "source": { 
        "script": "Write-Host Hello World!", 
        "scriptUri": "<SAS URI of a storage blob with read access or public URI>",  
        "commandId": "<Id>"  
        }, 
    "parameters": [ 
        { 
            "name": "param1",
            "value": "value1" 
            }, 
        { 
            "name": "param2", 
            "value": "value2" 
            } 
        ], 
    "protectedParameters": [ 
        { 
            "name": "secret1", 
            "value": "value1" 
            }, 
        { 
            "name": "secret2", 
            "value": "value2" 
            } 
        ], 
    "runAsUser": "userName",
    "runAsPassword": "userPassword", 
    "timeoutInSeconds": 3600,
    "treatFailureAsDeploymentFailure": true,
    "outputBlobUri": "< SAS URI of a storage append blob with read, add, create, write access>", 
    "errorBlobUri": "< SAS URI of a storage append blob with read, add, create, write access >"  
    }
}

Notas

  • Você pode fornecer um script embutido, um URI de script ou um ID de comando de script interno como fonte de entrada. URI de script é um URI SAS de blob de armazenamento com acesso de leitura ou URI público.
  • Apenas um tipo de entrada de origem é suportado para a execução de um comando.
  • A partir da API versão 2023-03-01, você pode definir a propriedade treatFailureAsDeploymentFailure como true fazendo com que a implantação falhe quando houver uma falha no script. Se definido como false, ProvisioningState refletirá apenas se o comando run foi executado ou não pela plataforma de extensões. Ele não indicaria se o script falhou em caso de falhas de script.
  • Run Command suporta a gravação de saída e erro em blobs de armazenamento usando os parâmetros outputBlobUri e errorBlobUri, que podem ser usados para armazenar saídas de script grandes. Use o URI SAS de um blob de acréscimo de armazenamento com acesso de leitura, adição, criação e gravação. O blob deve ser do tipo AppendBlob. Escrever a saída do script ou blob de erro falharia caso contrário. O blob será substituído se já existir. Será criado se não existir.

Listar instâncias em execução do Comando Executar em uma VM

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands?api-version=2023-03-01

Obter detalhes de saída para uma implantação específica do Run Command

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?$expand=instanceView&api-version=2023-03-01

Excluir uma implantação específica do Run Command

Você também pode excluir a instância de Run Command.

DELETE /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

Implantar scripts em uma sequência ordenada

Para implantar scripts sequencialmente, use um modelo de implantação, especificando uma dependsOn relação entre scripts sequenciais.

{ 
    "type": "Microsoft.Compute/virtualMachines/runCommands", 
    "name": "secondRunCommand", 
    "apiVersion": "2019-12-01", 
    "location": "[parameters('location')]", 
    "dependsOn": <full resourceID of the previous other Run Command>, 
    "properties": { 
        "source": {  
            "script": "Write-Host Hello World!"  
        }, 
        "timeoutInSeconds": 60  
    }
}

Execute vários comandos de execução sequencialmente

Por padrão, se você implantar vários recursos RunCommand usando o modelo de implantação, eles serão executados simultaneamente na VM. Se você tiver uma dependência dos scripts e uma ordem preferencial de execução, poderá usar a dependsOn propriedade para executá-los sequencialmente.

Neste exemplo, secondRunCommand será executado após firstRunCommand.

{
   "$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
   "contentVersion":"1.0.0.0",
   "resources":[
      {
         "type":"Microsoft.Compute/virtualMachines/runCommands",
         "name":"[concat(parameters('vmName'),'/firstRunCommand')]",
         "apiVersion":"2023-03-01",
         "location":"[parameters('location')]",
         "dependsOn":[
            "[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'))]"
         ],
         "properties":{
            "source":{
               "script":"Write-Host First: Hello World!"
            },
            "parameters":[
               {
                  "name":"param1",
                  "value":"value1"
               },
               {
                  "name":"param2",
                  "value":"value2"
               }
            ],
            "timeoutInSeconds":20
         }
      },
      {
         "type":"Microsoft.Compute/virtualMachines/runCommands",
         "name":"[concat(parameters('vmName'),'/secondRunCommand')]",
         "apiVersion":"2019-12-01",
         "location":"[parameters('location')]",
         "dependsOn":[
            "[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'),'runcommands/firstRunCommand')]"
         ],
         "properties":{
            "source":{
               "scriptUri":"http://github.com/myscript.ps1"
            },
            "timeoutInSeconds":60
         }
      }
   ]
}

Próximos passos

Para saber mais sobre outras maneiras de executar scripts e comandos remotamente em sua VM, consulte Executar scripts em sua VM do Windows.