Set-AzVMRunCommand

Referência

Módulo:: Az.Compute

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

Sintaxe

Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   -ScriptLocalPath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Exemplos

Exemplo 1: Criar ou atualizar o Run Command em uma VM usando uma URL SAS do blob de armazenamento

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=0I%2FIiYayRwHasfasasfdasdfasdeTsQjLnpZjA%3D"

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize o Run Command em uma VM do Windows usando uma URL SAS de um blob de armazenamento que contém o script .ps1. Observe que a URL SAS deve fornecer acesso de leitura ao blob. Um tempo de expiração de 24 horas é sugerido para a URL SAS. As URLs SAS podem ser geradas no portal do Azure usando as opções do blob ou o token SAS usando New-AzStorageBlobSASToken. Se estiver gerando token SAS usando New-AzStorageBlobSASToken, sua URL SAS = URL do blob base + "?" + token SAS de New-AzStorageBlobSASToken.

Exemplo 2: Criar ou atualizar o Run Command em uma VM usando um arquivo de script local.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize Executar Comando em uma VM usando um arquivo de script local que está no computador cliente em que o cmdlet é executado.

Exemplo 3: Criar ou atualizar o Run Command em uma VM usando texto de script.

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

Location      Name          Type
--------      ----          ----
eastus2euap   MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize Executar Comando em uma VM passando o conteúdo do script diretamente para o parâmetro -SourceScript. Use ';' para delimitar vários comandos.

Exemplo 4: criar ou atualizar o Run Command em uma VM usando commandId.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize Executar Comando em uma VM usando commandId preexistente. CommandIds disponíveis podem ser recuperadas usando Get-AzVMRunCommandDocument.

Exemplo 5: criar ou atualizar o Run Command em uma VM e transmitir mensagens de erro padrão e de saída padrão para blobs de acréscimo de saída e erro.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5hasfadsfasdF4jIkRJra4S5FlEo%3D" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5h%asfasdfgdT%2F4jasfasdf5FlEo%3D"

Location      Name          Type
--------      ----         ----
eastus2euap   MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize Executar Comando em uma VM e transmitir saída padrão e mensagens de erro padrão para blobs de acréscimo de saída e de erro. Observe que os blobs de saída e 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 a 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-AzStorageBlobSASToken. Se estiver gerando token SAS usando New-AzStorageBlobSASToken, sua URL SAS = URL do blob base + "?" + token SAS de New-AzStorageBlobSASToken.

Exemplo 6: criar ou atualizar o Run Command em uma VM, execute o Run Command como um usuário diferente usando os parâmetros RunAsUser e RunAsPassword.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Crie ou atualize o Run Command em uma VM, execute o Run Command como um usuário diferente usando os parâmetros RunAsUser e RunAsPassword. Para que RunAs funcione corretamente, entre em contato com o administrador da VM e verifique se o usuário foi adicionado à VM, se o usuário tem acesso aos recursos acessados pelo Executar Comando (Diretórios, Arquivos, Rede etc.) e, no caso da VM do Windows, se o serviço 'Logon Secundário' está em execução na VM.

Parâmetros

-AsJob

Executar o comando como um trabalho

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-AsyncExecution

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.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-DefaultProfile

O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Tipo:	PSObject
Aliases:	AzureRMContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ErrorBlobManagedIdentityClientId

ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ErrorBlobManagedIdentityObjectId

ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ErrorBlobUri

Especifica o blob de armazenamento do Azure em que o fluxo de erros de script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Location

Local do recurso

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-NoWait

Execute o comando de forma assíncrona

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-OutputBlobManagedIdentityClientId

ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-OutputBlobManagedIdentityObjectId

ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-OutputBlobUri

Especifica o blob de armazenamento do Azure em que o fluxo de saída do script será carregado. Use um URI SAS com acesso de leitura, acréscimo, criação, gravação OU use a identidade gerenciada para fornecer acesso à VM ao blob. Consulte o parâmetro outputBlobManagedIdentity.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Parameter

Os parâmetros usados pelo script. Para construir, consulte a seção NOTAS para propriedades PARAMETER e crie uma tabela de hash.

Tipo:	IRunCommandInputParameter[]
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ProtectedParameter

Os parâmetros usados pelo script. Para construir, consulte a seção NOTAS para propriedades PROTECTEDPARAMETER e crie uma tabela de hash.

Tipo:	IRunCommandInputParameter[]
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ResourceGroupName

O nome do grupo de recursos.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-RunAsPassword

Especifica a senha da conta de usuário na VM ao executar o comando de execução.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-RunAsUser

Especifica a conta de usuário na VM ao executar o comando de execução.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-RunCommandName

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

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ScriptLocalPath

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ScriptUriManagedIdentityClientId

ID do cliente (valor GUID) da identidade gerenciada atribuída pelo usuário. ObjectId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-ScriptUriManagedIdentityObjectId

ID do objeto (valor GUID) da identidade gerenciada atribuída pelo usuário. ClientId não deve ser usado se isso for fornecido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SourceCommandId

Especifica um commandId de script interno predefinido.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SourceScript

Especifica o conteúdo do script a ser executado na VM.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SourceScriptUri

Especifica o local de download do script. Pode ser o URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-SubscriptionId

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

Tipo:	String
Cargo:	Named
Valor padrão:	(Get-AzContext).Subscription.Id
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Tag

Marcações de recursos

Tipo:	Hashtable
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-TimeoutInSecond

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

Tipo:	Int32
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-TreatFailureAsDeploymentFailure

Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Falha. Se definido como false, ProvisioningState refletiria apenas se o comando de execução foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Veja a visualização da instância do comando run em caso de falhas de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-VMName

O nome da máquina virtual em que o comando de execução deve ser criado ou atualizado.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:	SwitchParameter
Aliases:	wi
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Saídas

IVirtualMachineRunCommand

Compartilhar via

Set-AzVMRunCommand

Sintaxe

Description

Exemplos

Exemplo 1: Criar ou atualizar o Run Command em uma VM usando uma URL SAS do blob de armazenamento

Exemplo 2: Criar ou atualizar o Run Command em uma VM usando um arquivo de script local.

Exemplo 3: Criar ou atualizar o Run Command em uma VM usando texto de script.

Exemplo 4: criar ou atualizar o Run Command em uma VM usando commandId.

Exemplo 5: criar ou atualizar o Run Command em uma VM e transmitir mensagens de erro padrão e de saída padrão para blobs de acréscimo de saída e erro.

Exemplo 6: criar ou atualizar o Run Command em uma VM, execute o Run Command como um usuário diferente usando os parâmetros RunAsUser e RunAsPassword.

Parâmetros

-AsJob

-AsyncExecution

-Confirm

-DefaultProfile

-ErrorBlobManagedIdentityClientId

-ErrorBlobManagedIdentityObjectId

-ErrorBlobUri

-Location

-NoWait

-OutputBlobManagedIdentityClientId

-OutputBlobManagedIdentityObjectId

-OutputBlobUri

-Parameter

-ProtectedParameter

-ResourceGroupName

-RunAsPassword

-RunAsUser

-RunCommandName

-ScriptLocalPath

-ScriptUriManagedIdentityClientId

-ScriptUriManagedIdentityObjectId

-SourceCommandId

-SourceScript

-SourceScriptUri

-SubscriptionId

-Tag

-TimeoutInSecond

-TreatFailureAsDeploymentFailure

-VMName

-WhatIf

Saídas

Recursos adicionais