Compartilhar via

Start-AzureRMAutomationRunbook

  • Referência
Módulo:
AzureRM.Automation

Inicia um trabalho de runbook.

Aviso

O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.

Sintaxe

Start-AzureRMAutomationRunbook
     [-Name] <String>
     [-Parameters <IDictionary>]
     [-RunOn <String>]
     [-ResourceGroupName] <String>
     [-AutomationAccountName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]
Start-AzureRMAutomationRunbook
     [-Name] <String>
     [-Parameters <IDictionary>]
     [-RunOn <String>]
     [-Wait]
     [-MaxWaitSeconds <Int32>]
     [-ResourceGroupName] <String>
     [-AutomationAccountName] <String>
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Description

O cmdlet Start-AzureRmAutomationRunbook inicia um trabalho de runbook da Automação do Azure. Especifique a ID ou o nome de um runbook.

Exemplos

Exemplo 1: Iniciar um trabalho de runbook

PS C:\>Start-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

Esse comando inicia um trabalho de runbook para o runbook chamado Runbk01 na conta de Automação do Azure chamada Contoso17.

Exemplo 2: Iniciar um trabalho de runbook e aguardar os resultados

Start-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01" -MaxWaitSeconds 1000 -Wait

Esse comando inicia um trabalho de runbook para o runbook chamado Runbk01 na conta de Automação do Azure chamada Contoso17. Esse comando especifica o parâmetro Wait . Portanto, ele retorna resultados após a conclusão do trabalho. O cmdlet aguarda até 1000 segundos pelos resultados.

Parâmetros

-AutomationAccountName

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

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

-MaxWaitSeconds

Especifica o número de segundos que esse cmdlet aguarda a conclusão de um trabalho antes de abandoná-lo. O valor padrão é 10800, ou três horas.

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

-Name

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

-Parameters

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

-ResourceGroupName

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

-RunOn

Especifica em qual Grupo de Trabalho Híbrido executar o runbook.

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

-Wait

Indica que esse cmdlet aguarda a conclusão, suspensão ou falha do trabalho e, em seguida, retorna o controle para o Azure PowerShell.

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

Entradas

String

Saídas

Job

-Esse cmdlet retorna um objeto Job , a menos que você especifique o parâmetro Wait . -Se você não especificar Wait, o Azure PowerShell retornará um objeto Job imediatamente. -Se você especificar Aguardar, o Azure PowerShell concluirá o trabalho e retornará o resultado. -O resultado não é um objeto Job .

PSObject