共用方式為

Start-AzAutomationRunbook

  • 參考
模組:
Az.Automation

啟動 Runbook 作業。

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

Description

Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。 指定 Runbook 的識別碼或名稱。

範例

範例 1：啟動 Runbook 作業

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

此命令會在名為 Contoso17 的 Azure 自動化 帳戶中，啟動名為 Runbk01 的 Runbook Runbook 作業。

範例 2：使用參數啟動 Python 2 Runbook 作業

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

此命令會在名為 Contoso17 的 Azure 自動化 帳戶中，針對名為 RunbkPy01 的 Python 2 Runbook 啟動 Runbook 作業，並將 “ValueForPosition1” 當做第二個位置參數和 “ValueForPosition2” 作為第二個位置參數。

範例 3：啟動 Runbook 作業並等候結果

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

此命令會在名為 Contoso17 的 Azure 自動化 帳戶中啟動名為 Runbk01 的 Runbook 作業。 此命令會 指定 Wait 參數。 因此，它會在作業完成之後傳回結果。 Cmdlet 會等候最多 1000 秒的結果。

參數

-AutomationAccountName

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxWaitSeconds

指定此 Cmdlet 在放棄作業之前等候作業完成的秒數。 默認值為 10800 或 3 小時。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Type:String
Aliases:RunbookName
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

Type:IDictionary
Aliases:JobParameters
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RunOn

指定要在其中執行 Runbook 的混合式背景工作角色群組。

Type:String
Aliases:HybridWorker
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Wait

表示此 Cmdlet 會等候作業完成、暫停或失敗，然後將控制權傳回 Azure PowerShell。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

String

輸出

Job

PSObject