Backup-AzKeyVaultKey

  • Riferimento
Modulo:
Az.KeyVault

Esegue il backup di una chiave in un insieme di credenziali delle chiavi.

Sintassi

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

Descrizione

Il cmdlet Backup-AzKeyVaultKey esegue il backup di una chiave specificata in un insieme di credenziali delle chiavi scaricandola e archiviandola in un file. Se sono presenti più versioni della chiave, tutte le versioni vengono incluse nel backup. Poiché il contenuto scaricato è crittografato, non può essere usato all'esterno di Azure Key Vault. È possibile ripristinare una chiave di cui è stato eseguito il backup in qualsiasi insieme di credenziali delle chiavi nella sottoscrizione da cui è stato eseguito il backup. I motivi tipici per usare questo cmdlet sono:

  • Si vuole depositare una copia della chiave, in modo da avere una copia offline nel caso in cui si elimini accidentalmente la chiave nell'insieme di credenziali delle chiavi.

  • È stata creata una chiave usando Key Vault e si vuole clonare la chiave in un'area di Azure diversa, in modo da poterla usare da tutte le istanze dell'applicazione distribuita. Usare il cmdlet Backup-AzKeyVaultKey per recuperare la chiave in formato crittografato e quindi usare il cmdlet Restore-AzKeyVaultKey e specificare un insieme di credenziali delle chiavi nella seconda area.

Esempio

Esempio 1: Eseguire il backup di una chiave con un nome file generato automaticamente

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

Questo comando recupera la chiave denominata MyKey dall'insieme di credenziali delle chiavi denominato MyKeyVault e salva un backup di tale chiave in un file denominato automaticamente e visualizza il nome del file.

Esempio 2: Eseguire il backup di una chiave in un nome file specificato

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Questo comando recupera la chiave denominata MyKey dall'insieme di credenziali delle chiavi denominato MyKeyVault e salva un backup di tale chiave in un file denominato Backup.blob.

Esempio 3: eseguire il backup di una chiave recuperata in precedenza in un nome di file specificato, sovrascrivendo il file di destinazione senza chiedere conferma.

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

C:\Backup.blob

Questo comando crea un backup della chiave denominata $key. Nome nell'insieme di credenziali denominato $key. VaultName in un file denominato Backup.blob, sovrascrivendo automaticamente il file, se esistente.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Force

Sovrascrivere il file specificato, se esistente

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-HsmName

Nome HSM. Il cmdlet costruisce il nome di dominio completo di un modulo di protezione hardware gestito in base al nome e all'ambiente attualmente selezionato.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-InputObject

Bundle di chiavi di cui eseguire il backup, inviato tramite pipeline dall'output di una chiamata di recupero.

Tipo:PSKeyVaultKeyIdentityItem
Alias:Key
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Specifica il nome della chiave di cui eseguire il backup.

Tipo:String
Alias:KeyName
Posizione:1
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-OutputFile

Specifica il file di output in cui è archiviato il BLOB di backup. Se non si specifica questo parametro, questo cmdlet genera automaticamente un nome file. Se si specifica il nome di un file di output esistente, l'operazione non verrà completata e restituirà un messaggio di errore che indica che il file di backup esiste già.

Tipo:String
Posizione:2
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-VaultName

Specifica il nome dell'insieme di credenziali delle chiavi che contiene la chiave di cui eseguire il backup.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PSKeyVaultKeyIdentityItem

Output

String