Remove-AzKeyVaultKey

  • Referencia
Módulo:
Az.KeyVault

Elimina una clave en un almacén de claves.

Syntax

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

El cmdlet Remove-AzKeyVaultKey elimina una clave en un almacén de claves. Si la clave se eliminó accidentalmente, la clave se puede recuperar mediante Undo-AzKeyVaultKeyRemoval por un usuario con permisos especiales de "recuperación". Este cmdlet tiene un valor alto para la propiedad ConfirmImpact .

Ejemplos

Ejemplo 1: Eliminación de una clave de un almacén de claves

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 quita la clave denominada ITSoftware del almacén de claves denominado Contoso.

Ejemplo 2: Quitar una clave sin confirmación del usuario

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

Este comando quita la clave denominada ITSoftware del almacén de claves denominado Contoso. El comando especifica el parámetro Force y, por lo tanto, el cmdlet no le pide confirmación.

Ejemplo 3: Purgar una clave eliminada del almacén de claves de forma permanente

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

Este comando quita la clave denominada ITSoftware del almacén de claves denominado Contoso permanentemente. La ejecución de este cmdlet requiere el permiso "purgar", que se debe haber concedido previamente y explícitamente al usuario para este almacén de claves.

Ejemplo 4: Eliminación de claves mediante el operador de canalización

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

Este comando obtiene todas las claves del almacén de claves denominado Contoso y las pasa al cmdlet Where-Object mediante el operador de canalización. Ese cmdlet pasa las claves que tienen un valor de $False para el atributo Enabled al cmdlet actual. Ese cmdlet quita esas claves.

Parámetros

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

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

-Force

Obliga al comando a ejecutarse sin solicitar la confirmación del usuario.

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

-HsmName

Nombre de HSM. El cmdlet construye el FQDN de un HSM administrado en función del nombre y del entorno seleccionado actualmente.

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

-InputObject

KeyBundle (objeto)

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

-InRemovedState

Quite la clave eliminada anteriormente de forma permanente.

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

-Name

Nombre de la clave que se va a quitar. Este cmdlet construye el nombre de dominio completo (FQDN) de una clave en función del nombre que especifica este parámetro, el nombre del almacén de claves y el entorno actual.

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

-PassThru

Indica que este cmdlet devuelve un objeto Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . De forma predeterminada, este cmdlet no genera ningún resultado.

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

-VaultName

Especifica el nombre del almacén de claves del que se va a quitar la clave. Este cmdlet construye el FQDN de un almacén de claves en función del nombre que especifica este parámetro y el entorno actual.

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

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta. Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

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

Entradas

PSKeyVaultKeyIdentityItem

Salidas

PSDeletedKeyVaultKey