< Back
Remove-AzureBatchJob
Post
NAME Remove-AzureBatchJob
SYNOPSIS
Deletes a Batch job.
SYNTAX
Remove-AzureBatchJob [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchJob cmdlet deletes an Azure Batch job. This cmdlet prompts you for confirmation before it removes a job, unless you specify
the Force parameter.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job that this cmdlet deletes. You cannot specify wildcard characters.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
OUTPUTS
NOTES
Example 1: Delete a Batch job
PS C:\\>Remove-AzureBatchJob -Id "Job-000001" -BatchContext $Context
This command deletes the job that has the ID Job-000001. The command prompts you for confirmation before it deletes the job. Use the
Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Delete a Batch job without confirmation by using the pipeline
PS C:\\>Get-AzureBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzureBatchJob -Force -BatchContext $Context
This command gets the job that has the ID Job-000002 by using the Get-AzureBatchJob cmdlet. The command passes that job to the current cmdlet by
using the pipeline operator. The command deletes that job. Because the command includes the Force parameter, it does not prompt you for
confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureBatchJob
Get-AzureRmBatchAccountKeys
New-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets
SYNOPSIS
Deletes a Batch job.
SYNTAX
Remove-AzureBatchJob [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force] [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchJob cmdlet deletes an Azure Batch job. This cmdlet prompts you for confirmation before it removes a job, unless you specify
the Force parameter.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the job that this cmdlet deletes. You cannot specify wildcard characters.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
OUTPUTS
NOTES
Example 1: Delete a Batch job
PS C:\\>Remove-AzureBatchJob -Id "Job-000001" -BatchContext $Context
This command deletes the job that has the ID Job-000001. The command prompts you for confirmation before it deletes the job. Use the
Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Delete a Batch job without confirmation by using the pipeline
PS C:\\>Get-AzureBatchJob -Id "Job-000002" -BatchContext $Context | Remove-AzureBatchJob -Force -BatchContext $Context
This command gets the job that has the ID Job-000002 by using the Get-AzureBatchJob cmdlet. The command passes that job to the current cmdlet by
using the pipeline operator. The command deletes that job. Because the command includes the Force parameter, it does not prompt you for
confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... rebatchjob
Disable-AzureBatchJob
Enable-AzureBatchJob
Get-AzureBatchJob
Get-AzureRmBatchAccountKeys
New-AzureBatchJob
Stop-AzureBatchJob
Azure Batch Cmdlets