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>]
说明
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 作业，并将第二个 Runbook 的“ValueForPosition2”作为第一个位置参数和“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 或 3 小时。
参数属性
| 类型: | Int32
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
BySynchronousReturnJobOutput
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Name
Start-AzAutomationRunbook cmdlet 启动Azure 自动化 Runbook 作业。
指定 Runbook 的 ID 或名称。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | RunbookName |
参数集
(All)
| Position: | 2 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Parameters
Start-AzAutomationRunbook cmdlet 启动Azure 自动化 Runbook 作业。
指定 Runbook 的 ID 或名称。
参数属性
| 类型: | IDictionary
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | JobParameters |
参数集
(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 |
| 别名: | HybridWorker |
参数集
(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。
输出
