Delen via

Start-AzAutomationRunbook

  • Referentie
Module:
Az.Automation

Start een runbooktaak.

Syntaxis

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

Description

De cmdlet Start-AzAutomationRunbook start een Azure Automation-runbooktaak. Geef de id of naam van een runbook op.

Voorbeelden

Voorbeeld 1: Een runbooktaak starten

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

Met deze opdracht wordt een runbooktaak gestart voor het runbook Runbk01 in het Azure Automation-account met de naam Contoso17.

Voorbeeld 2: Een Python 2-runbooktaak starten met parameters

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

Met deze opdracht wordt een runbooktaak gestart voor het Python 2-runbook met de naam RunbkPy01 in het Azure Automation-account met de naam Contoso17 met 'ValueForPosition1' als de eerste positionele parameter en 'ValueForPosition2' voor de tweede.

Voorbeeld 3: Een runbooktaak starten en wachten op resultaten

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

Met deze opdracht wordt een runbooktaak gestart voor het runbook Runbk01 in het Azure Automation-account met de naam Contoso17. Met deze opdracht geeft u de wachtparameter op. Daarom worden resultaten geretourneerd nadat de taak is voltooid. De cmdlet wacht maximaal 1000 seconden voor de resultaten.

Parameters

-AutomationAccountName

Type:String
Position:1
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-MaxWaitSeconds

Hiermee geeft u het aantal seconden op dat deze cmdlet wacht tot een taak is voltooid voordat de taak wordt verlaten. De standaardwaarde is 10800 of drie uur.

Type:Int32
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Name

Type:String
Aliassen:RunbookName
Position:2
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Parameters

Type:IDictionary
Aliassen:JobParameters
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ResourceGroupName

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-RunOn

Hiermee geeft u op op welke Hybrid Worker-groep het runbook moet worden uitgevoerd.

Type:String
Aliassen:HybridWorker
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Wait

Geeft aan dat deze cmdlet wacht tot de taak is voltooid, onderbroken of mislukt en vervolgens het besturingselement naar Azure PowerShell retourneert.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

String

Uitvoerwaarden

Job

PSObject