Backup-AzureKeyVaultKey

Realiza una copia de seguridad de una clave en un almacén de claves.

Importante

Como los módulos de Az PowerShell ya tienen todas las funcionalidades de los de AzureRM PowerShell, incluso más, el 29 de febrero de 2024 se van a retirar estos últimos.

Para evitar interrupciones del servicio, actualice los scripts que usan los módulos de AzureRM PowerShell para que utilicen los de Az PowerShell antes del 29 de febrero de 2024. Para actualizar automáticamente los scripts, siga la guía de inicio rápido.

Syntax

Backup-AzureKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzureKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

El cmdlet Backup-AzureKeyVaultKey realiza una copia de seguridad de una clave especificada en un almacén de claves al descargarla y almacenarla en un archivo. Si hay varias versiones de la clave, todas las versiones se incluyen en la copia de seguridad. Dado que el contenido descargado está cifrado, no se puede usar fuera de Azure Key Vault. Puede restaurar una clave de copia de seguridad en cualquier almacén de claves de la suscripción desde la que se hizo una copia de seguridad. Las razones típicas para usar este cmdlet son:

  • Desea custodiar una copia de la clave para que tenga una copia sin conexión en caso de que elimine accidentalmente la clave en el almacén de claves.

  • Ha creado una clave con Key Vault y ahora quiere clonar la clave en otra región de Azure, de modo que pueda usarla desde todas las instancias de la aplicación distribuida. Use el cmdlet Backup-AzureKeyVaultKey para recuperar la clave en formato cifrado y, a continuación, use el cmdlet Restore-AzureKeyVaultKey y especifique un almacén de claves en la segunda región.

Ejemplos

Ejemplo 1: Copia de seguridad de una clave con un nombre de archivo generado automáticamente

PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

C:\Users\username\mykeyvault-mykey-1527029447.01191

Este comando recupera la clave denominada MyKey del almacén de claves denominada MyKeyVault y guarda una copia de seguridad de esa clave en un archivo denominado automáticamente y muestra el nombre de archivo.

Ejemplo 2: Copia de seguridad de una clave en un nombre de archivo especificado

PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Este comando recupera la clave denominada MyKey del almacén de claves denominado MyKeyVault y guarda una copia de seguridad de esa clave en un archivo denominado Backup.blob.

Ejemplo 3: Haga una copia de seguridad de una clave recuperada previamente en un nombre de archivo especificado, sobrescribiendo el archivo de destino sin preguntar.

PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Este comando crea una copia de seguridad de la clave denominada $key. Nombre en el almacén denominado $key. VaultName en un archivo denominado Backup.blob, sobrescribiendo de forma silenciosa el archivo si ya existe.

Parámetros

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
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:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Force

Sobrescribir el archivo especificado si existe

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

-InputObject

Agrupación de claves para realizar copias de seguridad, canalizaciones desde la salida de una llamada de recuperación.

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

-Name

Especifica el nombre de la clave de la que se va a realizar una copia de seguridad.

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

-OutputFile

Especifica el archivo de salida en el que se almacena el blob de copia de seguridad. Si no especifica este parámetro, este cmdlet genera un nombre de archivo automáticamente. Si especifica el nombre de un archivo de salida existente, la operación no se completará y devolverá un mensaje de error que el archivo de copia de seguridad ya existe.

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

-VaultName

Especifica el nombre del almacén de claves que contiene la clave de la que se va a realizar una copia de seguridad.

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

-WhatIf

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

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

Entradas

PSKeyVaultKeyIdentityItem

Parámetros: InputObject (ByValue)

Salidas

String