Executar o comando em servidores habilitados para Azure Arc (versão prévia)

Os exemplos a seguir usam o módulo Az.ConnectedMachine para o Azure PowerShell para executar scripts ou comandos em um servidor habilitado para Arc.

Executar um script em um computador

Esse comando envia o script para o computador, executa-o e retorna a saída capturada.

New-AzConnectedMachineRunCommand -ResourceGroupName "myRG" -MachineName "myMachine" -Location "eastus" -RunCommandName "RunCommandName" –SourceScript "echo Hello World!"

Executar um script no computador usando um arquivo de script no armazenamento

Esse comando direciona o agente do Computador Conectado para um URI de SAS (assinatura de acesso compartilhado) para um blob de armazenamento em que um script foi carregado. Em seguida, ele direciona o agente para executar o script e retornar a saída capturada.

New-AzConnectedMachineRunCommand -ResourceGroupName "MyRG0" -MachineName "MyMachine" -RunCommandName "MyRunCommand" -Location "eastus" -SourceScriptUri “< SAS URI of a storage blob with read access or public URI>”

Listar todos os recursos do comando de execução implantados em uma máquina

Este comando retorna uma lista completa de comandos de execução implantados anteriormente com as respectivas propriedades.

Get-AzConnectedMachineRunCommand -ResourceGroupName "myRG" -MachineName "myMachine"

Obter resultados e status da execução

Esse comando recupera o progresso da execução atual para um comando Executar, incluindo saída mais recente, hora de início e término, código de saída e estado de terminal da execução.

Get-AzConnectedMachineRunCommand -ResourceGroupName "myRG" -MachineName "myMachine" -RunCommandName "RunCommandName"

Obter informações de status para um comando de execução por meio do Modo de Exibição de Instância

Esse comando obtém informações de status para um comando de execução na máquina com Exibição de Instância. A Exibição de Instância contém o estado de execução do comando Executar (bem-sucedido, com falha e assim por diante), código de saída, saída padrão e erro padrão gerados pela execução do script. Um código de saída diferente de zero indica uma execução malsucedida.

Get-AzConnectedMachineRunCommand -ResourceGroupName "MyRG" -MachineName "MyMachine" -RunCommandName "MyRunCommand"

Junto com outras informações, a resposta retorna estes campos:

• InstanceViewExecutionState: indica se o script foi bem-sucedido ou não.
• ProvisioningState: indica se a plataforma de extensão foi capaz de disparar o script de comando Executar ou não.

Criar ou atualizar o Comando Executar em um computador

Esse comando cria ou atualiza um comando de execução em um computador e transmite a saída padrão e as mensagens de erro padrão para os AppendBlobs de saída e erro.

New-AzConnectedMachineRunCommand -ResourceGroupName "MyRG0" -MachineName "MyMachine" -RunCommandName "MyRunCommand3" -Location "eastus" -SourceScript "id; echo HelloWorld" -OutputBlobUri <OutPutBlobUrI> -ErrorBlobUri <ErrorBlobUri>

Crie ou atualize o comando Executar em uma máquina como um usuário diferente

Esse comando cria ou atualiza um comando Executar em uma máquina como um usuário diferente, usando os parâmetros RunAsUser e RunAsPassword.

Antes de usar este comando:

• Contate o administrador do computador e verifique se o usuário tem acesso ao computador.
• Verifique se o usuário tem acesso aos recursos acessados pelo comando Executar, como diretórios, arquivos e recursos de rede.
• Em um computador Windows, verifique se o "Logon Secundário" está em execução.

New-AzConnectedMachineRunCommand -ResourceGroupName "MyRG0" -MachineName "MyMachine" -RunCommandName "MyRunCommand" -Location "eastus" -SourceScript "id; echo HelloWorld" -RunAsUser myusername -RunAsPassword mypassword

Criar ou atualizar o comando Executar em uma máquina com um arquivo de script local

Esse comando cria ou atualiza um comando Executar em um computador usando um arquivo de script local no computador cliente em que cmdlet é executado.

New-AzConnectedMachineRunCommand -ResourceGroupName "MyRG0" -MachineName "MyMachine" -RunCommandName "MyRunCommand" -Location "eastus" -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1"

Criar ou atualizar o comando Executar em um computador ao passar entradas confidenciais para o script

Esse comando cria ou atualiza o comando 'Run' especificado com ProtectedParameter para passar entradas confidenciais, como senhas ou chaves, para um script.

$privateParametersArray = @{name='inputText';value='privateParam1value'}

New-AzConnectedMachineRunCommand -MachineName "MyMachine" -ResourceGroupName "MyRG0" -RunCommandName "MyRunCommand" -Location "eastus" -SourceScriptUri <SourceScriptUri> -ProtectedParameter $privateParametersArray 

Script de exemplo para capturar texto de entrada:

param ([string]$inputText)
Write-Output $inputText

Você também pode passar parâmetros públicos de maneira semelhante usando Parameter.

• Para Windows: Parameter e ProtectedParameter são passados para um script semelhante ao seguinte exemplo: myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value

• Para Linux: um nome Parameter e seus valores são definidos como configuração de ambiente, que deve estar acessível dentro do script do PowerShell. Para argumentos sem nome, passe uma cadeia de caracteres vazia para nomear a entrada. Argumentos sem nome são passados para script semelhante ao seguinte exemplo: myscript.sh publicParam1value publicParam2value secret1value secret2value

Excluir recurso de comando Executar da máquina

Esse comando remove o recurso Executar comando implantado anteriormente no computador. Se a execução do script ainda estiver em andamento, a execução será encerrada.

Remove-AzConnectedMachineRunCommand -ResourceGroupName "myRG" -MachineName "myMachine" -RunCommandName "RunCommandName"

Os exemplos a seguir usam az connectedmachine run-command para executar um script de shell em um servidor habilitado para Arc.

Executar um script em um computador

Esse comando envia o script para o computador, executa-o e retorna a saída capturada.

az connectedmachine run-command create --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG" --script "Write-Host Hello World!"

Listar todos os recursos do comando de execução implantados em uma máquina

Esse comando retorna uma lista completa de comandos Executar implantados anteriormente junto com suas propriedades.

az connectedmachine run-command list --machine-name "myMachine" --resource-group "myRG"

Obter resultados e status da execução

Esse comando recupera o progresso da execução atual para um comando Executar, incluindo saída mais recente, hora de início e término, código de saída e estado de terminal da execução.

az connectedmachine run-command show --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG"

Excluir o recurso de comando Executar de uma máquina

Esse comando remove o recurso Executar comando implantado anteriormente no computador. Se a execução do script ainda estiver em andamento, a execução será encerrada.

az connectedmachine run-command delete --name "myRunCommand" --machine-name "myMachine" --resource-group "myRG"

Os comandos de exemplo nesta seção mostram como usar a API REST para configurar remotamente uma regra de firewall que permite o acesso ao ponto de extremidade www.microsoft.com/pkiops/certs. O cenário de exemplo usa cada uma das operações REST disponíveis e os seguintes valores:

• ID da assinatura - aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e
• Nome do servidor habilitado para Arc - 2012DatacenterServer1
• Grupo de recursos - ContosoRG
• Sistema operacional do servidor – servidores Windows Server 2012/R2

Criar acesso ao endpoint com um comando 'run'

Primeiro, crie um script de comando Run para fornecer acesso ao endpoint www.microsoft.com/pkiops/certs no servidor de destino habilitado para Arc usando a operação PUT.

Você pode fornecer o script em linha ou vincular ao arquivo de script.

Para fornecer o script embutido:

PUT https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands/EndpointAccessCommand?api-version=2024-11-10-preview

{
  "location": "eastus2",
  "properties": {
    "source": {
      "script": "New-NetFirewallRule -DisplayName $ruleName -Direction Outbound -Action Allow -RemoteAddress $endpoint -RemotePort $port -Protocol $protocol"
    },
    "parameters": [
      {
        "name": "ruleName",
        "value": "Allow access to www.microsoft.com/pkiops/certs"
      },
      {
        "name": "endpoint",
        "value": "www.microsoft.com/pkiops/certs"
      },
      {
        "name": "port",
      "value": 443
      },
      {
        "name": "protocol",
        "value": "TCP"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "contoso-user1",
    "runAsPassword": "Contoso123!",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Para vincular ao arquivo de script:

PUT https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands/EndpointAccessCommand?api-version=2024-11-10-preview

{
  "location": "eastus2",
  "properties": {
    "source": {
      "scriptUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/newnetfirewallrule.ps1"
    },
    "parameters": [
      {
        "name": "ruleName",
        "value": " Allow access to www.microsoft.com/pkiops/certs"
      },
      {
        "name": "endpoint",
        "value": "www.microsoft.com/pkiops/certs"
      },
      {
        "name": "port",
        "value": 443
      },
      {
        "name": "protocol",
        "value": "TCP"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "contoso-user1",
    "runAsPassword": "Contoso123!",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

scriptUri é um URI de SAS (assinatura de acesso compartilhado) para o blob de armazenamento, que deve fornecer acesso de leitura ao blob. É sugerido um período de expiração de 24 horas para o SAS URI. Você pode gerar um URI sas no portal do Azure usando opções de blobs ou token SAS usando New-AzStorageBlobSASToken. Se estiver gerando token SAS usando New-AzStorageBlobSASToken, o formato de URI SAS será: base blob URL + "?" + o token SAS de New-AzStorageBlobSASToken.

Os blobs de saída e de erro devem ser do tipo AppendBlob e suas URIs SAS devem fornecer acesso de leitura, acréscimo, criação e gravação ao blob. Um tempo de expiração de 24 horas é recomendado para a URI SAS. Você pode gerar URIs SAS no portal do Azure usando as opções do blob ou o token SAS usando New-AzStorageBlobSASToken.

Para saber mais sobre assinaturas de acesso compartilhado, consulte Conceder acesso limitado aos recursos do Armazenamento do Azure usando SAS (assinaturas de acesso compartilhado).

Verificar detalhes do comando Run

Verifique se você provisionou corretamente o comando Executar usando a operação GET:

GET https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands/EndpointAccessCommand?api-version=2024-11-10-preview

Atualizar o comando Executar

Você pode atualizar o comando Executar existente com novos parâmetros usando a operação PATCH. O exemplo a seguir adiciona acesso a outro ponto de extremidade, *.waconazure.com para conectividade com o Windows Admin Center.

PATCH https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands/EndpointAccessCommand?api-version=2024-11-10-preview

{
  "location": "eastus2",
  "properties": {
    "source": {
      "script": "New-NetFirewallRule -DisplayName $ruleName -Direction Outbound -Action Allow -RemoteAddress $endpoint -RemotePort $port -Protocol $protocol"
    },
    "parameters": [
      {
        "name": "ruleName",
        "value": "Allow access to WAC endpoint"
      },
      {
        "name": "endpoint",
        "value": "*.waconazure.com"
      },
      {
        "name": "port",
        "value": 443
      },
      {
        "name": "protocol",
        "value": "TCP"
      }
    ],
    "asyncExecution": false,
    "runAsUser": "contoso-user1",
    "runAsPassword": "Contoso123!",
    "timeoutInSeconds": 3600,
    "outputBlobUri": "https://mystorageaccount.blob.core.windows.net/myscriptoutputcontainer/MyScriptoutput.txt",
    "errorBlobUri": "https://mystorageaccount.blob.core.windows.net/mycontainer/MyScriptError.txt"
  }
}

Lista de comandos Executar

Antes de excluir o comando Executar para acesso ao ponto de extremidade, verifique se o servidor habilitado com Arc não tem outros comandos Executar. Use a operação LIST para obter todos os comandos de Execução no servidor com Arc habilitado:

LIST https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands?api-version=2024-11-10-preview

Excluir um comando Executar

Quando você não precisar mais da extensão Executar comando, exclua-a usando a seguinte operação DELETE:

DELETE https://management.azure.com/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoRG/providers/Microsoft.HybridCompute/machines/2012DatacenterServer1/runCommands/EndpointAccessCommand?api-version=2024-11-10-preview