你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Start-AzAutomationRunbook
启动 Runbook 作业。
语法
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>]
说明
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
类型: | String |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
类型: | IAzureContextContainer |
别名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-MaxWaitSeconds
指定此 cmdlet 等待作业在放弃作业之前完成的秒数。 默认值为 10800 或 3 小时。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Name
类型: | String |
别名: | RunbookName |
Position: | 2 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Parameters
类型: | IDictionary |
别名: | JobParameters |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ResourceGroupName
类型: | String |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-RunOn
指定要在其中运行 Runbook 的混合辅助角色组。
类型: | String |
别名: | HybridWorker |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Wait
指示此 cmdlet 等待作业完成、挂起或失败,然后将控制权返回到 Azure PowerShell。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |