Start-AzureRMAutomationRunbook

Runbook ジョブを開始します。

重要

Az PowerShell モジュール で AzureRM PowerShell モジュールのすべての機能およびその他を利用できるようになったため、2024 年 2 月 29 日に AzureRM PowerShell モジュールは廃止になります。

サービスの中断を回避するために、2024 年 2 月 29 日までに、AzureRM PowerShell モジュールを使用するスクリプトを更新して、Az PowerShell モジュールを使用するようにしてください。 スクリプトを自動的に更新するには、 クイックスタート ガイドに従ってください。

構文

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

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

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

このコマンドは、Contoso17 という名前のAzure Automation アカウントで Runbk01 という Runbook の Runbook ジョブを開始します。

例 2: Runbook ジョブを開始し、結果を待機する

Start-AzureRmAutomationRunbook -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
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

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

-MaxWaitSeconds

このコマンドレットがジョブの終了を待機してからジョブを破棄するまでの秒数を指定します。 既定値は 10800 または 3 時間です。

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

-Name

Type:String
Aliases:RunbookName
Position:2
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Parameters

Type:IDictionary
Aliases:JobParameters
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

-RunOn

Runbook を実行するハイブリッド Worker グループを指定します。

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

-Wait

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

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

入力

String

出力

Job

-Wait パラメーターを指定しない限り、このコマンドレットは Job オブジェクトを返します。 -Wait を指定しない場合、Azure PowerShellはすぐに Job オブジェクトを返します。 -Wait を指定した場合、Azure PowerShellはジョブを完了し、結果を返します。 -結果は Job オブジェクトではありません。

PSObject