Start-AzureRMAutomationRunbook
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 コマンドレットは、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
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-MaxWaitSeconds
このコマンドレットがジョブの終了を待機してからジョブを破棄するまでの秒数を指定します。 既定値は 10800 または 3 時間です。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
型: | String |
Aliases: | RunbookName |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Parameters
型: | IDictionary |
Aliases: | JobParameters |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-RunOn
Runbook を実行するハイブリッド Worker グループを指定します。
型: | String |
Aliases: | HybridWorker |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Wait
このコマンドレットは、ジョブの完了、中断、または失敗を待機し、Azure PowerShell に制御を返します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
-Wait パラメーターを指定しない限り、このコマンドレットは Job オブジェクトを返します。 -Wait を指定しない場合、Azure PowerShell はすぐに Job オブジェクトを返します。 -Wait を指定すると、Azure PowerShell によってジョブが完了し、結果が返されます。 -結果は Job オブジェクトではありません。