Remove-AzureBatchAccount
Remove-AzureBatchAccount
Removes the specified Batch account.
Syntax
Parameter Set: Default
Remove-AzureBatchAccount [-AccountName] <String> [[-ResourceGroupName] <String> ] [-Force] [-Profile <AzureProfile> ] [ <CommonParameters>]
Detailed Description
The Remove-AzureBatchAccount cmdlet removes the specified Azure Batch account. You will be prompted for confirmation unless you use the Force parameter.
Parameters
-AccountName<String>
Specifies the name of the batch account to remove.
Aliases |
Name |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Profile<AzureProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<String>
Specifies the resource group of the account to remove.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a batch account by name
This command removes the batch account named cmdletexample. The user is prompted for confirmation before the delete operation takes place.
PS C:\> Remove-AzureBatchAccount -AccountName "cmdletexample"