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-AzureBatchVMUser

Remove-AzureBatchVMUser

microsoft.azure.commands.batch.dll

Synopsis

Deletes the specified user account from the specified Azure Batch vm.

Syntax

Remove-AzureBatchVMUser [-PoolName] [-Name] [-BatchContext] [-Force] [<CommonParameters>]

Detailed Description

Deletes the specified user account from the specified Azure Batch vm.

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 user is deleted. Use this parameter to delete the user 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 user to delete. Wildcards are not permitted.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PoolName <string>

The name of the pool that contains the vm.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VMName <string>

The name of the vm that contains the user.

Aliases

None

Required?

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

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

C:\PS>

Description

-----------

Deletes the user named "myUser" from vm "tvm-1900272697_1-20150330t205553z" in pool "myPool". Since the Force parameter is present, the confirmation prompt is suppressed.

          Remove-AzureBatchVMUser -PoolName "myPool" -VMName "tvm-1900272697_1-20150330t205553z" -Name "myUser" -Force -BatchContext $context