共用方式為

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

Description

Start-AzureRmAutomationRunbook Cmdlet 會啟動 Azure 自動化 Runbook 作業。 指定 Runbook 的識別碼或名稱。

範例

範例 1：啟動 Runbook 作業

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

此命令會在名為 Contoso17 的 Azure 自動化 帳戶中啟動名為 Runbk01 的 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

-除非您指定 Wait 參數，否則此 Cmdlet 會傳回 Job 物件。 -如果您未指定 Wait，Azure PowerShell 會立即傳 回 Job 物件。 -如果您指定 Wait，Azure PowerShell 會完成作業，然後傳回結果。 -結果不是 Job 物件。

PSObject