Disable-AzBatchJob
Batch ジョブを無効にします。
構文
Disable-AzBatchJob
[-Id] <String>
[-DisableJobOption] <DisableJobOption>
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Disable-AzBatchJob コマンドレットは、Azure Batch ジョブを無効にします。 ジョブを有効にすると、新しいタスクを実行できます。 無効になっているジョブでは、新しいタスクは実行されません。 無効なジョブは後で有効にすることができます。
例
例 1: バッチ ジョブを無効にする
Disable-AzBatchJob -Id "Job-000001" -DisableJobOption "Terminate" -BatchContext $Context
このコマンドは、ID Job-000001 を持つジョブを無効にします。 このコマンドは、ジョブのアクティブなタスクを終了します。 $Context変数にコンテキストを割り当てるには、 Get-AzBatchAccountKey コマンドレットを使用します。
パラメーター
-BatchContext
このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。
型: | BatchAccountContext |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DisableJobOption
このコマンドレットで無効にするジョブに関連付けられているアクティブなタスクの操作を指定します。 有効な値は次の通りです。
- Requeue
- Terminate
- 待機
型: | DisableJobOption |
指定可能な値: | Requeue, Terminate, Wait |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Id
このコマンドレットで無効にするジョブの ID を指定します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |