Disable-AzBatchJob

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

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 を持つジョブを無効にします。 このコマンドは、ジョブのアクティブなタスクを終了します。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

パラメーター

-BatchContext

このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。

Type:BatchAccountContext
Position:Named
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

-DisableJobOption

このコマンドレットで無効にするジョブに関連付けられているアクティブなタスクの操作を指定します。 有効な値は次の通りです。

  • キュー
  • Terminate
  • 待機
Type:DisableJobOption
Accepted values:Requeue, Terminate, Wait
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Id

このコマンドレットで無効にするジョブの ID を指定します。

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

入力

String

BatchAccountContext

出力

Void