Get-AzBatchJobSchedule
Gets Batch job schedules.
Syntax
Get-AzBatchJobSchedule
[-Filter <String>]
[-MaxCount <Int32>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzBatchJobSchedule
[[-Id] <String>]
[-Select <String>]
[-Expand <String>]
-BatchContext <BatchAccountContext>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzBatchJobSchedule cmdlet gets Azure Batch job schedules for the Batch account specified by the BatchContext parameter. Specify an ID to get a single job schedule. Specify the Filter parameter to get the job schedules that match an Open Data Protocol (OData) filter.
Examples
Example 1: Get a job schedule by specifying an ID
Get-AzBatchJobSchedule -Id "JobSchedule23" -BatchContext $Context
CreationTime : 7/25/2015 9:15:43 PM
DisplayName :
ETag : 0x8D2953633427FCA
ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation
Id : JobSchedule23
JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification
LastModified : 7/25/2015 9:15:43 PM
Metadata :
PreviousState : Invalid
PreviousStateTransitionTime :
Schedule :
State : Active
StateTransitionTime : 7/25/2015 9:15:43 PM
Statistics :
Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23This command gets the job schedule that has the ID JobSchedule23. Use the Get-AzBatchAccountKey cmdlet to assign a context to the $Context variable.
Example 2: Get job schedules by using a filter
Get-AzBatchJobSchedule -Filter "startswith(id,'Job')" -BatchContext $Context
CreationTime : 7/25/2015 9:15:43 PM
DisplayName :
ETag : 0x8D2953633427FCA
ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation
Id : JobSchedule23
JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification
LastModified : 7/25/2015 9:15:43 PM
Metadata :
PreviousState : Invalid
PreviousStateTransitionTime :
Schedule :
State : Active
StateTransitionTime : 7/25/2015 9:15:43 PM
Statistics :
Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule23
CreationTime : 7/26/2015 5:39:33 PM
DisplayName :
ETag : 0x8D295E12B1084B4
ExecutionInformation : Microsoft.Azure.Commands.Batch.Models.PSJobScheduleExecutionInformation
Id : JobSchedule26
JobSpecification : Microsoft.Azure.Commands.Batch.Models.PSJobSpecification
LastModified : 7/26/2015 5:39:33 PM
Metadata :
PreviousState : Invalid
PreviousStateTransitionTime :
Schedule :
State : Active
StateTransitionTime : 7/26/2015 5:39:33 PM
Statistics :
Url : https://pfuller.westus.batch.azure.com/jobschedules/JobSchedule26This command gets all job schedules that have IDs that start with Job by specifying the Filter parameter.
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. This cmdlet returns job schedules that match the filter that this parameter specifies. If you do not specify a filter, this cmdlet returns all job schedules for the Batch context.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies the ID of the job schedule that this cmdlet gets. You cannot specify wildcard characters.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxCount
Specifies the maximum number of job schedules 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 |