Remove-AzKeyVault

  • Referência
Módulo:
Az.KeyVault

Exclui um cofre de chaves.

Syntax

Remove-AzKeyVault
      [-VaultName] <String>
      [[-ResourceGroupName] <String>]
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVault
      [-VaultName] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVault
      [-InputObject] <PSKeyVault>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVault
      [-InputObject] <PSKeyVault>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVault
      [-ResourceId] <String>
      [[-Location] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVault
      [-ResourceId] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Description

O cmdlet Remove-AzKeyVault exclui o cofre de chaves especificado. Ele também exclui todas as chaves e segredos contidos nessa instância. Observe que, embora a especificação do grupo de recursos seja opcional para esse cmdlet, você deve fazê-lo para obter um melhor desempenho.

Exemplos

Exemplo 1: Remover um cofre de chaves

Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru

True

Este comando remove o cofre de chaves chamado Contoso03Vault da sua assinatura atual.

Exemplo 2: Remover um cofre de chaves de um grupo de recursos especificado

Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru

True

Este comando remove o cofre de chaves chamado Contoso03Vault do grupo de recursos nomeado. Se você não especificar o nome do grupo de recursos, o cmdlet procurará o cofre da chave nomeada a ser excluído na sua assinatura atual.

Parâmetros

-AsJob

Executar cmdlet em segundo plano

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica que o cmdlet não solicita confirmação. Por padrão, esse cmdlet solicita que você confirme que deseja excluir o cofre de chaves.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Objeto do Cofre da Chave a ser excluído.

Type:PSKeyVault
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InRemovedState

Remova o cofre excluído anteriormente permanentemente.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Location

A localização do cofre excluído.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Este cmdlet não retorna um objeto por padrão. Se essa opção for especificada, ela retornará true se for bem-sucedida.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Especifica o nome de um grupo de recursos.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

ID do recurso KeyVault.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

O ID da assinatura. Por padrão, os cmdlets são executados na assinatura definida no contexto atual. Se o usuário especificar outra assinatura, o cmdlet atual será executado na assinatura especificada pelo usuário. A substituição de assinaturas só entra em vigor durante o ciclo de vida do cmdlet atual. Ele não altera a assinatura no contexto e não afeta cmdlets subsequentes.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VaultName

Especifica o nome do cofre de chaves a ser removido.

Type:String
Aliases:Name
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado. Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSKeyVault

String

Saídas

Boolean