Get-AzBatchJob

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

Batch アカウントまたはジョブ スケジュールの Batch ジョブを取得します。

構文

Get-AzBatchJob
   [-JobScheduleId <String>]
   [-Filter <String>]
   [-MaxCount <Int32>]
   [-Select <String>]
   [-Expand <String>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchJob
   [[-Id] <String>]
   [-Select <String>]
   [-Expand <String>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchJob
   [[-JobSchedule] <PSCloudJobSchedule>]
   [-Filter <String>]
   [-MaxCount <Int32>]
   [-Select <String>]
   [-Expand <String>]
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzBatchJob コマンドレットは、BatchAccountContext パラメーターで指定された Batch アカウントの Azure Batch ジョブを取得します。 Id パラメーターを使用すると、1 つのジョブを取得できます。 Filter パラメーターを使用すると、Open Data Protocol (OData) フィルターに一致するジョブを取得できます。 ジョブ スケジュール ID または PSCloudJobSchedule インスタンスを指定すると、このコマンドレットはそのジョブ スケジュールのジョブのみを返します。

例

例 1: ID で Batch ジョブを取得する

Get-AzBatchJob -Id "Job01" -BatchContext $Context

CommonEnvironmentSettings   :
Constraints                 : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints
CreationTime                : 7/25/2015 9:12:07 PM
DisplayName                 :
ETag                        : 0x8D29535B2941439
ExecutionInformation        : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation
Id                          : Job01
JobManagerTask              :
JobPreparationTask          :
JobReleaseTask              :
LastModified                : 7/25/2015 9:12:07 PM
Metadata                    :
PoolInformation             : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation
PreviousState               :
PreviousStateTransitionTime :
Priority                    : 0
State                       : Active
StateTransitionTime         : 7/25/2015 9:12:07 PM
Statistics                  :
Url                         : https://pfuller.westus.batch.azure.com/jobs/Job01

このコマンドは、ID Job01 を持つジョブを取得します。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

例 2: ジョブ スケジュールのすべてのアクティブなジョブを取得する

Get-AzBatchJob -JobScheduleId "JobSchedule27" -Filter "state eq 'active'" -BatchContext $Context

CommonEnvironmentSettings   :
Constraints                 : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints
CreationTime                : 7/25/2015 9:15:44 PM
DisplayName                 :
ETag                        : 0x8D2953633DD13E1
ExecutionInformation        : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation
Id                          : JobSchedule27:job-1
JobManagerTask              :
JobPreparationTask          :
JobReleaseTask              :
LastModified                : 7/25/2015 9:15:44 PM
Metadata                    :
PoolInformation             : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation
PreviousState               :
PreviousStateTransitionTime :
Priority                    : 0
State                       : Active
StateTransitionTime         : 7/25/2015 9:15:44 PM
Statistics                  :
Url                         : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1

このコマンドは、ID JobSchedule27 を持つジョブ スケジュールのアクティブなジョブを取得します。

例 3: パイプラインを使用してジョブ スケジュールのすべてのジョブを取得する

Get-AzBatchJobSchedule -Id "JobSchedule27" -BatchContext $Context | Get-AzBatchJob -BatchContext $Context

CommonEnvironmentSettings   :
Constraints                 : Microsoft.Azure.Commands.Batch.Models.PSJobConstraints
CreationTime                : 7/25/2015 9:15:44 PM
DisplayName                 :
ETag                        : 0x8D2953633DD13E1
ExecutionInformation        : Microsoft.Azure.Commands.Batch.Models.PSJobExecutionInformation
Id                          : JobSchedule27:job-1
JobManagerTask              :
JobPreparationTask          :
JobReleaseTask              :
LastModified                : 7/25/2015 9:15:44 PM
Metadata                    :
PoolInformation             : Microsoft.Azure.Commands.Batch.Models.PSPoolInformation
PreviousState               :
PreviousStateTransitionTime :
Priority                    : 0
State                       : Active
StateTransitionTime         : 7/25/2015 9:15:44 PM
Statistics                  :
Url                         : https://pfuller.westus.batch.azure.com/jobs/JobSchedule27:job-1

このコマンドは、Get-AzBatchJobSchedule コマンドレットを使用して、ID JobSchedule27 を持つジョブ スケジュールを取得します。 このコマンドは、パイプライン 演算子を使用して、そのジョブ スケジュールを現在のコマンドレットに渡します。 このコマンドは、そのジョブ スケジュールのすべてのジョブを取得します。

パラメーター

-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

-Expand

Open Data Protocol (OData) expand 句を指定します。 取得するメイン エンティティの関連エンティティを取得するには、このパラメーターの値を指定します。

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

-Filter

ジョブの OData フィルター句を指定します。 フィルターを指定しない場合、このコマンドレットは Batch アカウントまたはジョブ スケジュールのすべてのジョブを返します。

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

-Id

このコマンドレットが取得するジョブの ID を指定します。 ワイルドカード文字は指定できません。

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

-JobSchedule

ジョブを 含むジョブ スケジュールを表す PSCloudJobSchedule オブジェクトを指定します。 PSCloudJobSchedule オブジェクトを取得するには、Get-AzBatchJobSchedule コマンドレットを使用します。

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

-JobScheduleId

ジョブを含むジョブ スケジュールの ID を指定します。

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

-MaxCount

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Select

OData select 句を指定します。 すべてのオブジェクト プロパティではなく、特定のプロパティを取得するには、このパラメーターの値を指定します。

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

入力

String

PSCloudJobSchedule

BatchAccountContext

出力

PSCloudJob