Register-AzAutomationScheduledRunbook
構文
ByRunbookName (既定)
Register-AzAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByRunbookNameAndScheduleName
Register-AzAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
-RunbookName <String>
-ScheduleName <String>
[-Parameters <IDictionary>]
[-RunOn <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Register-AzAutomationScheduledRunbook コマンドレットは、Azure Automation Runbook をスケジュールに関連付けます。
Runbook は、 ScheduleName パラメーターを使用して指定したスケジュールに基づいて開始されます。
例
例 1: Runbook をスケジュールに関連付ける
Register-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01" -ScheduleName "Sched01" -ResourceGroupName "ResourceGroup01"
このコマンドは、Runbk01 という名前の Runbook を、Contoso17 という名前の Azure Automation アカウントの Sched01 という名前のスケジュールに関連付けます。
例 2
Runbook をスケジュールに関連付けます。 (autogenerated)
Register-AzAutomationScheduledRunbook -AutomationAccountName 'Contoso17' -Parameters <IDictionary> -ResourceGroupName 'ResourceGroup01' -RunbookName 'Runbk01' -ScheduleName 'Sched01'
パラメーター
-AutomationAccountName
このコマンドレットが動作する Runbook の Automation アカウントを指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Parameters
キーと値のペアのハッシュ テーブルを指定します。
キーは Runbook パラメーター名です。
値は Runbook パラメーターの値です。
関連付けられたスケジュールに応じて Runbook が開始されると、これらのパラメーターが Runbook に渡されます。
例: -Parameters @{"Key1"="Value1";"Key2"="Value2"}
パラメーターのプロパティ
| 型: | IDictionary
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByRunbookNameAndScheduleName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
スケジュールされた Runbook のリソース グループの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RunbookName
このコマンドレットがスケジュールに関連付ける Runbook の名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | 名前 |
パラメーター セット
ByRunbookNameAndScheduleName
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RunOn
ハイブリッド Runbook worker グループの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | HybridWorker |
パラメーター セット
ByRunbookNameAndScheduleName
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ScheduleName
このコマンドレットが Runbook を関連付けるスケジュールの名前を指定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByRunbookNameAndScheduleName
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力