< Back
Get-AzureBatchJob
Post
NAME Get-AzureBatchJob
SYNOPSIS
Gets Batch jobs for a Batch account or job schedule.
SYNTAX
Get-AzureBatchJob -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Filter <String>]
[-JobScheduleId <String>] [-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJob [[-JobSchedule] <PSCloudJobSchedule>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand
<String>] [-Filter <String>] [-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJob [[-Id] <String>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Select
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchJob 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.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expand <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job that this cmdlet gets. You cannot specify wildcard characters.
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobSchedule <PSCloudJobSchedule>
Specifies a PSCloudJobSchedule object that represents the job schedule which contains the jobs. To obtain a PSCloudJobSchedule object, use the
Get-AzureBatchJobSchedule cmdlet.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-JobScheduleId <String>
Specifies the ID of the job schedule which contains the jobs.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Select <String>
Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudJobSchedule
Parameter 'JobSchedule' accepts value of type 'PSCloudJobSchedule' from the pipeline
OUTPUTS
PSCloudJob
NOTES
Example 1: Get a Batch job by ID
PS C:\\>Get-AzureBatchJob -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
This command gets the job that has the ID Job01. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Get all active jobs for a job schedule
PS C:\\>Get-AzureBatchJob -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/ ... le27:job-1
This 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
PS C:\\>Get-AzureBatchJobSchedule -Id "JobSchedule27" -BatchContext $Context | Get-AzureBatchJob -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/ ... le27:job-1
This command gets the job schedule that has the ID JobSchedule27 by using the Get-AzureBatchJobSchedule 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
New-AzureBatchJob
Remove-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets
SYNOPSIS
Gets Batch jobs for a Batch account or job schedule.
SYNTAX
Get-AzureBatchJob -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Filter <String>]
[-JobScheduleId <String>] [-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJob [[-JobSchedule] <PSCloudJobSchedule>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand
<String>] [-Filter <String>] [-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJob [[-Id] <String>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Select
<String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchJob 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.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys 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.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Expand <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Filter <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job that this cmdlet gets. You cannot specify wildcard characters.
Required? false
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobSchedule <PSCloudJobSchedule>
Specifies a PSCloudJobSchedule object that represents the job schedule which contains the jobs. To obtain a PSCloudJobSchedule object, use the
Get-AzureBatchJobSchedule cmdlet.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-JobScheduleId <String>
Specifies the ID of the job schedule which contains the jobs.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MaxCount <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Select <String>
Specifies an OData select clause. Specify a value for this parameter to get specific properties rather than all object properties.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
PSCloudJobSchedule
Parameter 'JobSchedule' accepts value of type 'PSCloudJobSchedule' from the pipeline
OUTPUTS
PSCloudJob
NOTES
Example 1: Get a Batch job by ID
PS C:\\>Get-AzureBatchJob -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
This command gets the job that has the ID Job01. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Get all active jobs for a job schedule
PS C:\\>Get-AzureBatchJob -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/ ... le27:job-1
This 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
PS C:\\>Get-AzureBatchJobSchedule -Id "JobSchedule27" -BatchContext $Context | Get-AzureBatchJob -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/ ... le27:job-1
This command gets the job schedule that has the ID JobSchedule27 by using the Get-AzureBatchJobSchedule 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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
New-AzureBatchJob
Remove-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets