Compartir a través de

Backup-AzKeyVaultKey

Módulo:
Az.KeyVault Module

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

Sintaxis

ByKeyName (valor predeterminado) 

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

HsmByKeyName 

Backup-AzKeyVaultKey
    [-Name] <String>
    [[-OutputFile] <String>]
    -HsmName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKey 

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

Description

El cmdlet Backup-AzKeyVaultKey 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 realizó una copia de seguridad. Las razones habituales para usar este cmdlet son:

  • Quiere 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 mediante 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-AzKeyVaultKey para recuperar la clave en formato cifrado y, a continuación, use el cmdlet Restore-AzKeyVaultKey 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

Backup-AzKeyVaultKey -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

Backup-AzKeyVaultKey -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: Realice una copia de seguridad de una clave recuperada previamente en un nombre de archivo especificado, sobrescribiendo el archivo de destino sin preguntar.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -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 el archivo de forma silenciosa si ya existe.

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultProfile

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

Propiedades de parámetro

Tipo:IAzureContextContainer
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Force

Sobrescribir el archivo especificado si existe

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-HsmName

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

HsmByKeyName
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

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

Propiedades de parámetro

Tipo:PSKeyVaultKeyIdentityItem
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Key

Conjuntos de parámetros

ByKey
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Nombre de clave

Conjuntos de parámetros

ByKeyName
Posición:1
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
HsmByKeyName
Posición:1
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByKeyName
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-WhatIf

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

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

PSKeyVaultKeyIdentityItem

Salidas

String