< Back
Remove-AzureBatchTask
Post
NAME Remove-AzureBatchTask
SYNOPSIS
Deletes a Batch task.
SYNTAX
Remove-AzureBatchTask [-JobId] <String> [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureBatchTask [-InputObject] <PSCloudTask> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchTask cmdlet deletes an Azure Batch task. This cmdlet prompts you for confirmation, 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 task that this cmdlet deletes. You cannot specify wildcard characters.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSCloudTask>
Specifies the task that this cmdlet deletes. To obtain a PSCloudTask object, use the Get-AzureBatchTask cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-JobId <String>
Specifies the ID of the job that contains the task.
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
PSCloudTask
Parameter 'InputObject' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
NOTES
Example 1: Delete a Batch task by ID
PS C:\\>Remove-AzureBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context
This command deletes a task that has the ID Task23 under the job that has the ID Job-000001. The command prompts you for confirmation. Use the
Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Delete a Batch task by using the pipeline without confirmation
PS C:\\>Get-AzureBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Remove-AzureBatchTask -Force -BatchContext $Context
This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the Get-AzureBatchTask cmdlet. The command
passes that task to the current cmdlet by using the pipeline operator. The command deletes that task. This command specifies the Force parameter.
Therefore, the command does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchtask
Get-AzureRmBatchAccountKeys
Get-AzureBatchTask
New-AzureBatchTask
Remove-AzureBatchTask
Stop-AzureBatchTask
Azure Batch Cmdlets
SYNOPSIS
Deletes a Batch task.
SYNTAX
Remove-AzureBatchTask [-JobId] <String> [-Id] <String> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureBatchTask [-InputObject] <PSCloudTask> -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-Force]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureBatchTask cmdlet deletes an Azure Batch task. This cmdlet prompts you for confirmation, 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 task that this cmdlet deletes. You cannot specify wildcard characters.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InputObject <PSCloudTask>
Specifies the task that this cmdlet deletes. To obtain a PSCloudTask object, use the Get-AzureBatchTask cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-JobId <String>
Specifies the ID of the job that contains the task.
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
PSCloudTask
Parameter 'InputObject' accepts value of type 'PSCloudTask' from the pipeline
OUTPUTS
NOTES
Example 1: Delete a Batch task by ID
PS C:\\>Remove-AzureBatchTask -JobId "Job-000001" -Id "Task23" -BatchContext $Context
This command deletes a task that has the ID Task23 under the job that has the ID Job-000001. The command prompts you for confirmation. Use the
Get-AzureRmBatchAccountKeys cmdlet to assign a context to the $Context variable.
Example 2: Delete a Batch task by using the pipeline without confirmation
PS C:\\>Get-AzureBatchTask -JobId "Job-000001" -Id "Task26" -BatchContext $Context | Remove-AzureBatchTask -Force -BatchContext $Context
This command gets the Batch task that has the ID Task26 in the job that has the ID Job-000001 by using the Get-AzureBatchTask cmdlet. The command
passes that task to the current cmdlet by using the pipeline operator. The command deletes that task. This command specifies the Force parameter.
Therefore, the command does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ebatchtask
Get-AzureRmBatchAccountKeys
Get-AzureBatchTask
New-AzureBatchTask
Remove-AzureBatchTask
Stop-AzureBatchTask
Azure Batch Cmdlets