Compartilhar via


Start-AzAutomationRunbook

Inicia um trabalho de runbook.

Sintaxe

ByAsynchronousReturnJob (Default)

Start-AzAutomationRunbook
    [-Name] <String>
    [-ResourceGroupName] <String>
    [-AutomationAccountName] <String>
    [-Parameters <IDictionary>]
    [-RunOn <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

BySynchronousReturnJobOutput

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

Description

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

Exemplos

Exemplo 1: Iniciar um trabalho de runbook

Start-AzAutomationRunbook -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 do Python 2 com parâmetros

$params = [ordered]@{"Key1"="ValueForPosition1";"Key2"="ValueForPosition2"}
Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "RunbkPy01" -ResourceGroupName "ResourceGroup01" -Parameters $params

Esse comando inicia um trabalho de runbook para o runbook do Python 2 chamado RunbkPy01 na conta de Automação do Azure chamada Contoso17 com "ValueForPosition1" como o primeiro parâmetro posicional e "ValueForPosition2" para o segundo.

Exemplo 3: iniciar um trabalho de runbook e aguardar os resultados

Start-AzAutomationRunbook -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

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MaxWaitSeconds

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

Propriedades do parâmetro

Tipo:Int32
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

BySynchronousReturnJobOutput
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:RunbookName

Conjuntos de parâmetros

(All)
Cargo:2
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Parameters

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

Propriedades do parâmetro

Tipo:IDictionary
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:JobParameters

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-RunOn

Especifica qual Grupo de Hybrid Worker no qual executar o runbook.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:HybridWorker

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Wait

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

BySynchronousReturnJobOutput
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Saídas

Job

PSObject