< Back
Disable-AzureBatchJobSchedule
Post
NAME Disable-AzureBatchJobSchedule
SYNOPSIS
Disables a Batch job schedule.
SYNTAX
Disable-AzureBatchJobSchedule [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Disable-AzureBatchJobSchedule cmdlet disables an Azure Batch job schedule. If you disable a schedule, jobs are not created according to that
schedule. You can enable a disabled schedule later.
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
-Id <String>
Specifies the ID of the job schedule that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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
NOTES
Example 1: Disable a job schedule
PS C:\\>Disable-AzureBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context
This command disables the job schedule that has the ID JobSchedule17. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the
$Context variable.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
New-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets
SYNOPSIS
Disables a Batch job schedule.
SYNTAX
Disable-AzureBatchJobSchedule [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Disable-AzureBatchJobSchedule cmdlet disables an Azure Batch job schedule. If you disable a schedule, jobs are not created according to that
schedule. You can enable a disabled schedule later.
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
-Id <String>
Specifies the ID of the job schedule that this cmdlet disables.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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
NOTES
Example 1: Disable a job schedule
PS C:\\>Disable-AzureBatchJobSchedule -Id "JobSchedule17" -BatchContext $Context
This command disables the job schedule that has the ID JobSchedule17. Use the Get-AzureRmBatchAccountKeys cmdlet to assign a context to the
$Context variable.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... obschedule
Enable-AzureBatchJobSchedule
Get-AzureRmBatchAccountKeys
Get-AzureBatchJobSchedule
New-AzureBatchJobSchedule
Remove-AzureBatchJobSchedule
Stop-AzureBatchJobSchedule
Azure Batch Cmdlets