Compartir a través de

Backup-AzureKeyVaultSecret

  • Referencia
Módulo:
AzureRM.KeyVault

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

Advertencia

El módulo AzureRM PowerShell ha quedado oficialmente obsoleto a partir del 29 de febrero de 2024. Se recomienda a los usuarios migrar de AzureRM al módulo Az PowerShell para seguir recibiendo soporte técnico y actualizaciones.

Aunque el módulo AzureRM puede seguir funcionando, ya no recibirá mantenimiento ni soporte técnico, lo que significa que su uso continuado queda a discreción y riesgo del usuario. Consulte nuestros recursos de migración para ver una guía sobre la transición al módulo Az.

Sintaxis

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

Description

El cmdlet Backup-AzureKeyVaultSecret realiza una copia de seguridad de un secreto especificado en un almacén de claves al descargarlo y almacenarlo 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-AzureKeyVaultSecret para recuperar el secreto en formato cifrado y, a continuación, use el cmdlet Restore-AzureKeyVaultSecret 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

PS C:\Users\username\> Backup-AzureKeyVaultSecret -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

PS C:\> Backup-AzureKeyVaultSecret -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

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -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.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Force

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

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-InputObject

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

Tipo:PSKeyVaultSecretIdentityItem
Alias:Secret
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Name

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

Tipo:String
Alias:SecretName
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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.

Tipo:String
Posición:2
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-VaultName

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

Tipo:String
Posición:0
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

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

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

PSKeyVaultSecretIdentityItem

Parámetros: InputObject (ByValue)

Salidas

String