Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureBatchWorkItem

Remove-AzureBatchWorkItem

microsoft.azure.commands.batch.dll

Synopsis

Deletes the specified Azure Batch workitem.

Syntax

Remove-AzureBatchWorkItem [-Name] [-BatchContext] [-Force] [<CommonParameters>]

Detailed Description

Deletes the specified Azure Batch workitem. You will be prompted for confirmation unless you use the Force parameter.

Parameters

-BatchContext <BatchAccountContext>

The BatchAccountContext instance to use when interacting with the Batch service. Use the Get-AzureBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys populated.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Force <SwitchParameter>

If this parameter is not present, then you will be prompted for confirmation before the workitem is deleted. Use this parameter to delete the workitem without being asked for confirmation.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <string>

The name of the workitem to delete. Wildcards are not permitted.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

Deletes the workitem named "myWorkItem". The user is prompted for confirmation before the delete operation takes place.

        Remove-AzureBatchWorkItem "myWorkItem" -BatchContext $context
      

-------------------------- EXAMPLE 2 --------------------------

C:\PS>

Description

-----------

Deletes the workitem named "myWorkItem2". Since the Force parameter is present, the confirmation prompt is suppressed.

        Get-AzureBatchWorkItem -Name "myWorkItem2" -BatchContext $context | Remove-AzureBatchWorkItem -Force -BatchContext $context