通过

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

Start-AzureRMAutomationRunbook

  • 参考
模块:
AzureRM.Automation

启动 Runbook 作业。

警告

AzureRM PowerShell 模块已自 2024 年 2 月 29 日起正式弃用。 为了确保持续获得支持和更新，建议用户从 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

类型:String
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

类型:IAzureContextContainer
别名: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

输入

String

输出

Job

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

PSObject