Start-AzureRMAutomationRunbook

  • Referenz
Modul:
AzureRM.Automation

Startet einen Runbook-Auftrag.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

Beschreibung

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

Beispiele

Beispiel 1: Starten eines Runbook-Auftrags

PS C:\>Start-AzureRmAutomationRunbook -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 Runbookauftrags und Warten auf Ergebnisse

Start-AzureRmAutomationRunbook -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: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

-Dieses Cmdlet gibt ein Job-Objekt zurück, es sei denn, Sie geben den Wait-Parameter an. -Wenn Sie "Wait" nicht angeben, gibt Azure PowerShell sofort ein Job-Objekt zurück. -Wenn Sie "Wait" angeben, schließt Azure PowerShell den Auftrag ab und gibt das Ergebnis zurück. -Das Ergebnis ist kein Job-Objekt .

PSObject