Remove-AzKeyVaultKey

  • Referência
Módulo:
Az.KeyVault

Exclui uma chave em um cofre de chaves.

Sintaxe

Remove-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [-Force]
      [-PassThru]
      [-InRemovedState]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzKeyVaultKey exclui uma chave em um cofre de chaves. Se a chave foi excluída acidentalmente, a chave pode ser recuperada usando Undo-AzKeyVaultKeyRemoval por um usuário com permissões especiais de 'recuperação'. Este cmdlet tem um valor alto para a propriedade ConfirmImpact .

Exemplos

Exemplo 1: Remover uma chave de um cofre de chaves

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru

Vault Name           : contoso
Name                 : key2
Id                   : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date         : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled              : False
Expires              : 10/11/2018 11:32:49 PM
Not Before           : 4/11/2018 11:22:49 PM
Created              : 4/12/2018 10:16:38 PM
Updated              : 4/12/2018 10:16:38 PM
Purge Disabled       : False
Tags                 :

Este comando remove a chave chamada ITSoftware do cofre de chaves chamado Contoso.

Exemplo 2: Remover uma chave sem confirmação do utilizador

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force

Este comando remove a chave chamada ITSoftware do cofre de chaves chamado Contoso. O comando especifica o parâmetro Force e, portanto, o cmdlet não solicita confirmação.

Exemplo 3: Limpar uma chave excluída do cofre de chaves permanentemente

Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState

Este comando remove a chave chamada ITSoftware do cofre de chaves chamado Contoso permanentemente. A execução desse cmdlet requer a permissão 'purge', que deve ter sido concedida prévia e explicitamente ao usuário para esse cofre de chaves.

Exemplo 4: Remover chaves usando o operador de pipeline

Get-AzKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzKeyVaultKey

Este comando obtém todas as chaves no cofre de chaves chamado Contoso e as passa para o cmdlet Where-Object usando o operador de pipeline. Esse cmdlet passa as chaves que têm um valor de $False para o atributo Enabled para o cmdlet atual. Esse cmdlet remove essas chaves.

Parâmetros

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Force

Força o comando a ser executado sem pedir a confirmação do usuário.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-HsmName

Nome HSM. O cmdlet constrói o FQDN de um HSM gerenciado com base no nome e no ambiente selecionado no momento.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Objeto KeyBundle

Tipo:PSKeyVaultKeyIdentityItem
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-InRemovedState

Remova a chave excluída anteriormente permanentemente.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Name

Especifica o nome da chave a ser removida. Este cmdlet constrói o FQDN (nome de domínio totalmente qualificado) de uma chave com base no nome especificado por esse parâmetro, no nome do cofre de chaves e no seu ambiente atual.

Tipo:String
Aliases:KeyName
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Indica que esse cmdlet retorna um objeto Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Por padrão, esse cmdlet não gera nenhuma saída.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-VaultName

Especifica o nome do cofre de chaves do qual a chave deve ser removida. Este cmdlet constrói o FQDN de um cofre de chaves com base no nome especificado por esse parâmetro e no seu ambiente atual.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais: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
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PSKeyVaultKeyIdentityItem

Saídas

PSDeletedKeyVaultKey