Backup-AzKeyVaultSecret

  • Referencia
Módulo:
Az.KeyVault

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

Syntax

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

Description

El cmdlet Backup-AzKeyVaultSecret realiza una copia de seguridad de un secreto especificado en un almacén de claves mediante la descarga y el almacenamiento en un archivo. Si hay varias versiones del secreto, 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 un secreto de copia de seguridad en cualquier almacén de claves de la suscripción desde la que se realizó una copia de seguridad. Las razones habituales para usar este cmdlet son:

  • Quiere custodiar una copia del secreto para que tenga una copia sin conexión en caso de que elimine accidentalmente el secreto en el almacén de claves.
  • Ha agregado un secreto a un almacén de claves y ahora quiere clonar el secreto en otra región de Azure, de modo que pueda usarlo desde todas las instancias de la aplicación distribuida. Use el cmdlet Backup-AzKeyVaultSecret para recuperar el secreto en formato cifrado y, a continuación, use el cmdlet Restore-AzKeyVaultSecret y especifique un almacén de claves en la segunda región. (Tenga en cuenta que las regiones deben pertenecer a la misma geografía).

Ejemplos

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

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

Este comando recupera el secreto denominado MySecret del almacén de claves denominado MyKeyVault y guarda una copia de seguridad de ese secreto en un archivo denominado automáticamente y muestra el nombre de archivo.

Ejemplo 2: Realizar una copia de seguridad de un secreto en un nombre de archivo especificado, sobrescribir el archivo existente sin preguntar

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Este comando recupera el secreto denominado MySecret del almacén de claves denominado MyKeyVault y guarda una copia de seguridad de ese secreto en un archivo denominado Backup.blob.

Ejemplo 3: Copia de seguridad de un secreto recuperado previamente en un nombre de archivo especificado

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Este comando usa el nombre y el nombre del almacén del objeto $secret para recuperar el secreto y guardar su copia de seguridad en un archivo denominado Backup.blob.

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

Le pide confirmación antes de sobrescribir el archivo de salida, si existe.

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

-InputObject

Secreto al que se va a realizar una copia de seguridad, canalizado desde la salida de una llamada de recuperación.

Type:PSKeyVaultSecretIdentityItem
Aliases:Secret
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Especifica el nombre del secreto del que se va a realizar una copia de seguridad.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
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 indica que el archivo de copia de seguridad ya existe.

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

-VaultName

Especifica el nombre del almacén de claves que contiene el secreto de copia de seguridad.

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.

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

Entradas

PSKeyVaultSecretIdentityItem

Salidas

String