Partilhar via

Remove-AzureRmKeyVault

  • Referência
Módulo:
AzureRM.KeyVault

Exclui um cofre de chaves.

Aviso

O módulo AzureRM PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Syntax

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

Description

O cmdlet Remove-AzureRmKeyVault 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

PS C:\> Remove-AzureRmKeyVault -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

PS C:\> Remove-AzureRmKeyVault -VaultName "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

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predefinido:False
Necessário: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

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
valor predefinido:None
Necessário: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.

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Objeto do Cofre da Chave a ser excluído.

Tipo:PSKeyVault
Position:0
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-InRemovedState

Remova o cofre excluído anteriormente permanentemente.

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:False
Accept wildcard characters:False

-Location

A localização do cofre excluído.

Tipo:String
Position:2
valor predefinido:None
Necessário: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.

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Especifica o nome de um grupo de recursos.

Tipo:String
Position:1
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

ID do recurso KeyVault.

Tipo:String
Position:0
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-VaultName

Especifica o nome do cofre de chaves a ser removido.

Tipo:String
Position:0
valor predefinido:None
Necessário: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.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predefinido:False
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSKeyVault

Parâmetros: InputObject (ByValue)

String

Saídas

Boolean