< Back
Get-AzureBatchJobSchedule
Post
NAME Get-AzureBatchJobSchedule
SYNOPSIS
Gets Batch job schedules.
SYNTAX
Get-AzureBatchJobSchedule -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Filter <String>]
[-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJobSchedule [[-Id] <String>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>]
[-Select <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchJobSchedule 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.
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. 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job schedule that this cmdlet gets. You cannot specify wildcard characters.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-MaxCount <Int32>
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.
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
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
PSCloudJobSchedule
NOTES
Example 1: Get a job schedule by specifying an ID
PS C:\\>Get-AzureBatchJobSchedule -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/ ... Schedule23
This command gets the job schedule that has the ID JobSchedule23. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context
variable.
Example 2: Get job schedules by using a filter
PS C:\\>Get-AzureBatchJobSchedule -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/ ... Schedule23
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/ ... Schedule26
This command gets all job schedules that have IDs that start with Job by specifying the Filter parameter.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Disable-AzureBatchJobSchedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
New-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets
SYNOPSIS
Gets Batch job schedules.
SYNTAX
Get-AzureBatchJobSchedule -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>] [-Filter <String>]
[-MaxCount <Int32>] [-Select <String>] [<CommonParameters>]
Get-AzureBatchJobSchedule [[-Id] <String>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Expand <String>]
[-Select <String>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchJobSchedule 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.
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. 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job schedule that this cmdlet gets. You cannot specify wildcard characters.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-MaxCount <Int32>
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.
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
String
Parameter 'Id' accepts value of type 'String' from the pipeline
OUTPUTS
PSCloudJobSchedule
NOTES
Example 1: Get a job schedule by specifying an ID
PS C:\\>Get-AzureBatchJobSchedule -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/ ... Schedule23
This command gets the job schedule that has the ID JobSchedule23. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context
variable.
Example 2: Get job schedules by using a filter
PS C:\\>Get-AzureBatchJobSchedule -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/ ... Schedule23
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/ ... Schedule26
This command gets all job schedules that have IDs that start with Job by specifying the Filter parameter.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Disable-AzureBatchJobSchedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
New-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets