你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Start-AzureRMAutomationRunbook

参考

模块:: AzureRM.Automation

启动 Runbook 作业。

警告

截至 2024 年 2 月 29 日，AzureRM PowerShell 模块已正式弃用。为了确保持续获得支持和更新，建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行，但它不再维护或受支持，但会根据用户的自由裁量权和风险继续使用任何继续使用模块。有关过渡到 Az 模块的指导，请参阅我们的迁移资源。

语法

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

说明

Start-AzureRmAutomationRunbook cmdlet 启动Azure 自动化 Runbook 作业。指定 Runbook 的 ID 或名称。

示例

示例 1：启动 Runbook 作业

PS C:\>Start-AzureRmAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

此命令在名为 Contoso17 的 Azure 自动化帐户中为名为 Runbk01 的 Runbook 启动 Runbook 作业。

示例 2：启动 Runbook 作业并等待结果

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

此命令在名为 Contoso17 的 Azure 自动化帐户中为名为 Runbk01 的 Runbook 启动 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:	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

-此 cmdlet 返回 Job 对象，除非指定 Wait 参数。 -如果未指定 Wait，Azure PowerShell 将立即返回作业对象。 -如果指定 Wait，Azure PowerShell 将完成该作业，然后返回结果。 -结果不是 Job 对象。

PSObject