Set-AzVMRunCommand
A operação para criar ou atualizar o comando run.
Syntax
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 run.
Exemplos
Exemplo 1: Criar ou atualizar o comando Executar em uma VM usando uma URL SAS de 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 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 de 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 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. Observação 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 de 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ErrorBlobUri
Especifica o blob de armazenamento do Azure onde 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 o acesso da VM ao blob. Consulte o parâmetro errorBlobManagedIdentity.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
Local do recurso
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Execute o comando de forma assíncrona
Tipo: | SwitchParameter |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OutputBlobUri
Especifica o blob de armazenamento do Azure onde 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 o acesso da VM ao blob. Consulte o parâmetro outputBlobManagedIdentity.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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[] |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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[] |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
O nome do grupo de recursos.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunAsPassword
Especifica a senha da conta de usuário na VM ao executar o comando run.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunAsUser
Especifica a conta de usuário na VM ao executar o comando run.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunCommandName
O nome do comando run da máquina virtual.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScriptLocalPath
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceCommandId
Especifica um commandId de script interno predefinido.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceScript
Especifica o conteúdo do script a ser executado na VM.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SourceScriptUri
Especifica o local de download do script. Pode ser URI SAS de um blob de armazenamento do Azure com acesso de leitura ou URI público.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 |
Position: | Named |
valor padrão: | (Get-AzContext).Subscription.Id |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Marcações de recursos
Tipo: | Hashtable |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TimeoutInSecond
O tempo limite em segundos para executar o comando run.
Tipo: | Int32 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TreatFailureAsDeploymentFailure
Opcional. Se definido como true, qualquer falha no script falhará na implantação e ProvisioningState será marcado como Failed. Se definido como false, ProvisioningState refletiria apenas se o comando run foi executado ou não pela plataforma de extensões, não indicaria se o script falhou em caso de falhas de script. Consulte a exibiçã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 |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMName
O nome da máquina virtual onde o comando run deve ser criado ou atualizado.
Tipo: | String |
Position: | Named |
valor padrão: | None |
Obrigatório: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Position: | Named |
valor padrão: | None |
Obrigatório: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |