Share via

Disable-AzBatchComputeNodeScheduling

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

指定したコンピューティング ノードのタスク スケジュールを無効にします。

構文

Disable-AzBatchComputeNodeScheduling
       [-PoolId] <String>
       [-Id] <String>
       [-DisableSchedulingOption <DisableComputeNodeSchedulingOption>]
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]
Disable-AzBatchComputeNodeScheduling
       [[-ComputeNode] <PSComputeNode>]
       [-DisableSchedulingOption <DisableComputeNodeSchedulingOption>]
       -BatchContext <BatchAccountContext>
       [-DefaultProfile <IAzureContextContainer>]
       [<CommonParameters>]

説明

Disable-AzBatchComputeNodeScheduling コマンドレットは、指定されたコンピューティング ノードでのタスク スケジュールを無効にします。 コンピューティング ノードは、特定のアプリケーション ワークロード専用の Azure 仮想マシンです。 コンピューティング ノードでタスク スケジュールを無効にすると、ノードのタスク キュー内の現在のジョブに対する処理を決定することもできます。 Disable-AzBatchComputeNodeScheduling では、次の操作を行うことができます。

  • タスクを終了し、ジョブ キューに戻します。 これにより、これらのタスクを別のコンピューティング ノードで再スケジュールできます。
  • タスクを終了し、ジョブ キューからタスクを削除します。 この方法で停止したタスクは再スケジュールされません。
  • 現在実行中のすべてのタスクが完了するのを待ってから、コンピューティング ノードでのタスク スケジュールを無効にします。
  • 実行中のすべてのタスクが完了し、すべてのデータ保持期間が期限切れになるまで待ってから、コンピューティング ノードでのタスク スケジュールを無効にします。

例

例 1: コンピューティング ノードでタスク スケジュールを無効にする

$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount"
Disable-AzBatchComputeNodeScheduling -PoolId "myPool" -Id "tvm-1783593343_34-20151117t222514z" -BatchContext $Context

これらのコマンドは、コンピューティング ノード tvm-1783593343_34-20151117t222514z のタスク スケジュールを無効にします。 これを行うには、この例の最初のコマンドで、バッチ アカウント contosobatchaccount のアカウント キーへのオブジェクト参照を作成します。 このオブジェクト参照は、$contextという名前の変数に格納されます。 2 番目のコマンドでは、このオブジェクト参照と Disable-AzBatchComputeNodeScheduling コマンドレットを 使用してプール myPool に接続し、ノード tvm-1783593343_34-20151117t222514z でタスク スケジュールを無効にします。 DisableComputeNodeSchedulingOptions パラメーターに含まれていないため、コンピューティング ノードで現在実行中のタスクは再キューされます。

例 2: プール内のすべてのコンピューティング ノードでタスク スケジュールを無効にする

$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount"
Get-AzBatchComputeNode -PoolId "Pool06"  -BatchContext $Context | Disable-AzBatchComputeNodeScheduling -BatchContext $Context

これらのコマンドを実行すると、バッチ プール Pool06 内のすべてのコンピューター ノードでタスクのスケジュール設定が無効になります。 このタスクを実行するために、この例の最初のコマンドは、バッチ アカウント contosobatchaccount のアカウント キーへのオブジェクト参照を作成します。 このオブジェクト参照は、$contextという名前の変数に格納されます。 次に、この例の 2 番目のコマンドでは、このオブジェクト参照と Get-AzBatchComputeNode を使用して、Pool06 で見つかったすべてのコンピューティング ノードのコレクションを返します。 その後、そのコレクションをパイプ処理して Disable-AzBatchComputeNodeScheduling コマンドレットを 実行し、コレクション内の各コンピューティング ノードのタスク スケジュールを無効にします。 DisableComputeNodeSchedulingOptions パラメーターに含まれていないため、コンピューティング ノードで現在実行中のタスクは再キューされます。

パラメーター

-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

-ComputeNode

タスクのスケジュール設定が無効になっているコンピューティング ノードへのオブジェクト参照を指定します。 このオブジェクト参照は、Get-AzBatchComputeNode コマンドレットを使用して作成され、返されたコンピューティング ノード オブジェクトを変数に格納します。

Type:PSComputeNode
Position:0
Default value:None
Required:False
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

-DisableSchedulingOption

スケジュール設定が無効になっているコンピューター ノードで現在実行されているタスクを、このコマンドレットが処理する方法を指定します。 このパラメーターの有効値は、次のとおりです。

  • キュー。 タスクはすぐに停止され、ジョブ キューに返されます。 これにより、タスクを別のコンピューティング ノードで再スケジュールできます。 これが既定値です。
  • Terminate。 タスクはすぐに停止され、ジョブ キューから削除されます。 これらのタスクは再スケジュールされません。
  • TaskCompletion。 現在実行中のタスクは、コンピューティング ノードでタスク スケジュールが無効になる前に完了できます。 このノードでは、新しいタスクはスケジュールされません。
  • RetainedData。 現在実行中のタスクは完了でき、コンピューティング ノードでタスクのスケジュール設定が無効になる前に、データ保持期間が期限切れになります。 このノードでは、新しいタスクはスケジュールされません。
Type:Nullable<T>[DisableComputeNodeSchedulingOption]
Accepted values:Requeue, Terminate, TaskCompletion
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

タスクのスケジュール設定が無効になっているコンピューティング ノードの ID を指定します。

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

-PoolId

タスクのスケジュール設定が無効になっているコンピューティング ノードを含むバッチ プールの ID を指定します。 PoolId パラメーターを使用する場合は、同じコマンドで ComputeNode パラメーターを使用しないでください。

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

入力

PSComputeNode

BatchAccountContext

出力

Void