Remove-AzKeyVault

  • Referencia
Módulo:
Az.KeyVault

Elimina un almacén de claves.

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

El cmdlet Remove-AzKeyVault elimina el almacén de claves especificado. También elimina todas las claves y secretos contenidos en esa instancia. Tenga en cuenta que, aunque especificar el grupo de recursos es opcional para este cmdlet, debe hacerlo para mejorar el rendimiento.

Ejemplos

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

Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru

True

Este comando quita el almacén de claves denominado Contoso03Vault de la suscripción actual.

Ejemplo 2: Eliminación de un almacén de claves de un grupo de recursos especificado

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

True

Este comando quita el almacén de claves denominado Contoso03Vault del grupo de recursos con nombre. Si no especifica el nombre del grupo de recursos, el cmdlet busca el almacén de claves con nombre que se va a eliminar en la suscripción actual.

Parámetros

-AsJob

Ejecución del cmdlet en segundo plano

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

-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

Indica que el cmdlet no le pide confirmación. De forma predeterminada, este cmdlet le pide que confirme que desea eliminar el almacén de claves.

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

-InputObject

Objeto de Key Vault que se va a eliminar.

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

-InRemovedState

Quite permanentemente el almacén eliminado anteriormente.

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

-Location

Ubicación del almacén eliminado.

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

-PassThru

Este cmdlet no devuelve un objeto de forma predeterminada. Si se especifica este modificador, devuelve true si se ejecuta correctamente.

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

-ResourceGroupName

Especifica el nombre de un grupo de recursos.

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

-ResourceId

Id. de recurso de KeyVault.

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

-SubscriptionId

Identificador de la suscripción. De forma predeterminada, los cmdlets se ejecutan en la suscripción que se establece en el contexto actual. Si el usuario especifica otra suscripción, el cmdlet actual se ejecuta en la suscripción especificada por el usuario. La invalidación de suscripciones solo surte efecto durante el ciclo de vida del cmdlet actual. No cambia la suscripción en el contexto y no afecta a los cmdlets posteriores.

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

-VaultName

Especifica el nombre del almacén de claves que se va a quitar.

Type:String
Aliases:Name
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

PSKeyVault

String

Salidas

Boolean