Backup-AzureKeyVaultKey

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

Avviso

Il modulo AzureRM PowerShell è stato ufficialmente deprecato a partire dal 29 febbraio 2024. È consigliabile eseguire la migrazione da AzureRM al modulo Az PowerShell per garantire il supporto e gli aggiornamenti continui.

Anche se il modulo AzureRM può ancora funzionare, non è più gestito o supportato, posizionando qualsiasi uso continuo a discrezione e rischio dell'utente. Per indicazioni sulla transizione al modulo Az, vedere le risorse di migrazione.

Sintassi

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>]

Descrizione

Il cmdlet Backup-AzureKeyVaultKey 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-AzureKeyVaultKey per recuperare la chiave in formato crittografato e quindi usare il cmdlet Restore-AzureKeyVaultKey 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

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

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

PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -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.

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Sovrascrivere il file specificato, se esistente

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

-InputObject

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

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

-Name

Specifica il nome della chiave di cui eseguire il backup.

Type:String
Aliases:KeyName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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à.

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

-VaultName

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

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

-WhatIf

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

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

Input

PSKeyVaultKeyIdentityItem

Parametri: InputObject (ByValue)

Output

String