Start-AzAutomationRunbook

  • Referenz
Modul:
Az.Automation

Startet einen Runbook-Auftrag.

Syntax

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>]

Beschreibung

Das Cmdlet Start-AzAutomationRunbook startet einen Azure Automation-Runbook-Auftrag. Geben Sie die ID oder den Namen eines Runbook an.

Beispiele

Beispiel 1: Starten eines Runbook-Auftrags

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

Dieser Befehl startet einen Runbookauftrag für das Runbook mit dem Namen Runbk01 im Azure Automation-Konto namens Contoso17.

Beispiel 2: Starten eines Python 2-Runbookauftrags mit Parametern

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

Dieser Befehl startet einen Runbookauftrag für das Python 2-Runbook mit dem Namen RunbkPy01 im Azure Automation-Konto "Contoso17" mit "ValueForPosition1" als ersten Positionsparameter und "ValueForPosition2" für die zweite.

Beispiel 3: Starten eines Runbookauftrags und Warten auf Ergebnisse

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

Dieser Befehl startet einen Runbookauftrag für das Runbook mit dem Namen Runbk01 im Azure Automation-Konto namens Contoso17. Dieser Befehl gibt den Wait-Parameter an. Daher werden Ergebnisse zurückgegeben, nachdem der Auftrag abgeschlossen wurde. Das Cmdlet wartet bis zu 1000 Sekunden auf die Ergebnisse.

Parameter

-AutomationAccountName

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-MaxWaitSeconds

Gibt die Anzahl der Sekunden an, die dieses Cmdlet wartet, bis ein Auftrag abgeschlossen ist, bevor er den Auftrag abgibt. Der Standardwert ist 10800 oder drei Stunden.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Name

Typ:String
Aliase:RunbookName
Position:2
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Parameters

Typ:IDictionary
Aliase:JobParameters
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ResourceGroupName

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-RunOn

Gibt an, auf welcher Hybridarbeitsgruppe das Runbook ausgeführt werden soll.

Typ:String
Aliase:HybridWorker
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Wait

Gibt an, dass dieses Cmdlet wartet, bis der Auftrag abgeschlossen, angehalten oder fehlschlägt, und gibt dann die Steuerung an Azure PowerShell zurück.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

String

Ausgaben

Job

PSObject