Get-AzBatchSubtask

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

指定したタスクのサブタスク情報を取得します。

構文

Get-AzBatchSubtask
   [-JobId] <String>
   [-TaskId] <String>
   [-MaxCount <Int32>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchSubtask
   [[-Task] <PSCloudTask>]
   [-MaxCount <Int32>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzBatchSubtask コマンドレットは、指定したタスクに関するサブタスク情報を取得します。 サブタスクは、個々のタスクに並列処理を提供し、タスクの実行と進行状況を正確に監視できるようにします。

例

例 1: 指定したタスクのすべてのサブタスクを返す

$Context = Get-AzBatchAccountKey -AccountName "contosobatchaccount"
Get-AzBatchSubtask -JobId "Job-01" -TaskID "myTask" -BatchContext $Context

これらのコマンドは、ID myTask を持つタスクのすべてのサブタスクを返します。 これを行うには、この例の最初のコマンドで、バッチ アカウント contosobatchaccount のアカウント キーへのオブジェクト参照を作成します。 このオブジェクト参照は、$contextという名前の変数に格納されます。 次に、2 番目のコマンドでは、そのオブジェクト参照と Get-AzBatchSubtask コマンドレットを使用して、ジョブ 01 の一部として実行されるタスク myTask のすべてのサブタスクを返します。

パラメーター

-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

-JobId

このコマンドレットが取得するサブタスクを持つタスクを含むジョブの ID を指定します。

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

-MaxCount

返されるサブタスクの最大数を指定します。 0 以下の値を指定した場合、このコマンドレットでは上限は使用されません。 既定値は 1000 です。

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

-Task

このコマンドレットが返すサブタスクを含むタスクへのオブジェクト参照を指定します。 このオブジェクト参照は、Get-AzBatchTask コマンドレットを使用して作成され、返されたオブジェクトを変数に格納します。

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

-TaskId

このコマンドレットが返すサブタスクを持つタスクの ID を指定します。

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

入力

String

PSCloudTask

BatchAccountContext

出力

PSSubtaskInformation