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

Remove-AzureKeyVault

microsoft.azure.commands.keyvault.dll

Synopsis

Deletes an Azure Key Vault instance.

Syntax

Remove-AzureKeyVault [-VaultName] [-ResourceGroupName] [-Force] [-Profile] [<CommonParameters>]

Detailed Description

The Remove-AzureKeyVault cmdlet deletes the specified Azure Key Vault instance. It also deletes all keys and secrets contained in that instance.

Note that although specifying the resource group is optional for this cmdlet, you should so for better performance.

Parameters

-Force <SwitchParameter>

Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to delete the key vault.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <Microsoft.Azure.Common.Authentication.Models.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 <System.String>

Specifies the name of a resource group.

Aliases

none

Required?

false

Position

2

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-VaultName <String>

Specifies the name of the key vault to remove.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type

String

Return Type


Notes

None

Examples

Example 1: Remove a key vault

This command removes the key vault named Contoso03Vault from your current subscription.

PS C:\>Remove-AzureKeyVault -VaultName "Contoso03Vault" 

Example 2: Remove a key vault from a specified resource group

This command removes the key vault named Contoso03Vault from the named resource group. If you do not specify the resource group name, the cmdlet searches for the named key vault to delete in your current subscription.

PS C:\>Remove-AzureKeyVault -VaultName "Contoso03Vault" -ResourceGroupName "Group14"

Online Version
Get-AzureKeyVault
New-AzureKeyVault