Get-AzBatchJob
Gets Batch jobs for a Batch account or job schedule.
Syntax
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>] Description
The Get-AzBatchJob cmdlet gets the Azure Batch jobs for the Batch account specified by the BatchAccountContext parameter. You can use the Id parameter to get a single job. You can use the Filter parameter to get the jobs that match an Open Data Protocol (OData) filter. If you supply a job schedule ID or PSCloudJobSchedule instance, this cmdlet returns only the jobs for that job schedule.
Examples
Example 1: Get a Batch job by ID
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/Job01This command gets the job that has the ID Job01. Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable.
Example 2: Get all active jobs for a job schedule
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-1This command gets the active jobs for the job schedule that has the ID JobSchedule27.
Example 3: Gets all jobs under a job schedule by using the pipeline
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-1This command gets the job schedule that has the ID JobSchedule27 by using the Get-AzBatchJobSchedule cmdlet. The command passes that job schedule to the current cmdlet by using the pipeline operator. The command gets all jobs for that job schedule.
Parameters
-BatchContext
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service. To use shared key authentication instead, use the Get-AzBatchAccountKey cmdlet to get a BatchAccountContext object with its access keys populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the BatchAccountContext.KeyInUse property.
| Type: | BatchAccountContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Expand
Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Specifies an OData filter clause for jobs. If you do not specify a filter, this cmdlet returns all jobs for the Batch account or job schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies the ID of the job that this cmdlet gets. You cannot specify wildcard characters.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobSchedule
Specifies a PSCloudJobSchedule object that represents the job schedule which contains the jobs. To obtain a PSCloudJobSchedule object, use the Get-AzBatchJobSchedule cmdlet.
| Type: | PSCloudJobSchedule |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobScheduleId
Specifies the ID of the job schedule which contains the jobs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxCount
Specifies the maximum number of jobs to return. If you specify a value of zero (0) or less, the cmdlet does not use an upper limit. The default value is 1000.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Select
Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |