Start-AzAutomationRunbook
語法
ByAsynchronousReturnJob (預設值)
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
Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。
指定 Runbook 的 ID 或名稱。
範例
範例 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 啟動 Runbook 作業。
此命令指定 Wait 參數。
因此，它會在作業完成後傳回結果。
Cmdlet 最多會等候 1000 秒才能取得結果。
參數
-AutomationAccountName
Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。
指定 Runbook 的 ID 或名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-DefaultProfile
用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-MaxWaitSeconds
指定此 Cmdlet 在放棄作業之前等候作業完成的秒數。
預設值為 10800，或三小時。
參數屬性
| 類型: | Int32
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
BySynchronousReturnJobOutput
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。
指定 Runbook 的 ID 或名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | Runbook名稱 |
參數集
(All)
| Position: | 2 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Parameters
Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。
指定 Runbook 的 ID 或名稱。
參數屬性
| 類型: | IDictionary
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 工作參數 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResourceGroupName
Start-AzAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。
指定 Runbook 的 ID 或名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-RunOn
指定要執行 Runbook 的混合式背景工作角色群組。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 混合工作者 |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Wait
表示此 Cmdlet 會等候作業完成、暫停或失敗，然後將控制權傳回給 Azure PowerShell。
參數屬性
參數集
BySynchronousReturnJobOutput
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
輸出
