Stop-AzBatchTask

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

Batch タスクを停止します。

構文

Stop-AzBatchTask
    [-JobId] <String>
    [-Id] <String>
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Stop-AzBatchTask
    [-Task] <PSCloudTask>
    -BatchContext <BatchAccountContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

説明

Stop-AzBatchTask コマンドレットは、Azure Batch タスクを停止します。

例

例 1: ID で Batch タスクを削除する

Stop-AzBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context

このコマンドは、ID Job-000001 を持つジョブの下に ID Task23 を持つタスクを停止します。 コマンドを実行すると、確認を求められます。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

例 2: パイプラインを使用して Batch タスクを停止する

Get-AzBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Stop-AzBatchTask -BatchContext $Context

このコマンドは、Get-AzBatchTask コマンドレットを使用して、ID Job-0000001 を持つジョブに ID Task26 を持つ Batch タスクを取得します。 このコマンドは、パイプライン演算子を使用して、そのタスクを現在のコマンドレットに渡します。 このコマンドは、そのタスクを停止します。

パラメーター

-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

-Id

このコマンドレットが停止するタスクの ID を指定します。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-JobId

タスクを含むジョブの ID を指定します。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Task

このコマンドレットが停止するタスクを指定します。 PSCloudTask オブジェクトを取得するには、Get-AzBatchTask コマンドレットを使用します。

型:PSCloudTask
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

String

PSCloudTask

BatchAccountContext

出力

Void