Start-AzAutomationRunbook

  • リファレンス
モジュール:
Az.Automation

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 コマンドレットは、Azure Automation Runbook ジョブを開始します。 Runbook の ID または名前を指定します。

例

例 1: Runbook ジョブを開始する

Start-AzAutomationRunbook -AutomationAccountName "Contoso17" -Name "Runbk01" -ResourceGroupName "ResourceGroup01"

このコマンドは、Contoso17 という名前の Azure Automation アカウントで 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 Automation アカウントで RunbkPy01 という名前の Python 2 Runbook ジョブの Runbook ジョブを開始し、最初の位置パラメーターとして "ValueForPosition1" を、2 番目の位置パラメーターとして "ValueForPosition2" を指定します。

例 3: Runbook ジョブを開始し、結果を待つ

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

このコマンドは、Contoso17 という名前の Azure Automation アカウントで Runbk01 という Runbook の Runbook ジョブを開始します。 このコマンドは Wait パラメーターを指定します。 そのため、ジョブの完了後に結果が返されます。 コマンドレットは、結果を最大 1000 秒待機します。

パラメーター

-AutomationAccountName

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MaxWaitSeconds

このコマンドレットがジョブの終了を待機してからジョブを破棄するまでの秒数を指定します。 既定値は 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 を実行するハイブリッド Worker グループを指定します。

Type:String
Aliases:HybridWorker
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Wait

このコマンドレットは、ジョブの完了、中断、または失敗を待機し、Azure PowerShell に制御を返します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

出力

Job

PSObject