Condividi tramite

Backup-AzureKeyVaultSecret

  • Riferimento
Modulo:
AzureRM.KeyVault

Esegue il backup di un segreto 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-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>]

Descrizione

Il cmdlet Backup-AzureKeyVaultSecret esegue il backup di un segreto specificato in un insieme di credenziali delle chiavi scaricandolo e archiviandolo in un file. Se sono presenti più versioni del segreto, tutte le versioni vengono incluse nel backup. Poiché il contenuto scaricato è crittografato, non può essere usato all'esterno di Azure Key Vault. È possibile ripristinare un segreto sottoposto a 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 del segreto, in modo da avere una copia offline nel caso in cui si elimini accidentalmente il segreto nell'insieme di credenziali delle chiavi.
  • È stato aggiunto un segreto a un insieme di credenziali delle chiavi e ora si vuole clonare il segreto in un'area di Azure diversa, in modo da poterlo usare da tutte le istanze dell'applicazione distribuita. Usare il cmdlet Backup-AzureKeyVaultSecret per recuperare il segreto in formato crittografato e quindi usare il cmdlet Restore-AzureKeyVaultSecret e specificare un insieme di credenziali delle chiavi nella seconda area. Si noti che le aree devono appartenere alla stessa area geografica.

Esempio

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

PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

Questo comando recupera il segreto denominato MySecret dall'insieme di credenziali delle chiavi denominato MyKeyVault e salva un backup del segreto in un file denominato automaticamente e visualizza il nome del file.

Esempio 2: Eseguire il backup di un segreto in un nome file specificato, sovrascrivendo il file esistente senza chiedere conferma

PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Questo comando recupera il segreto denominato MySecret dall'insieme di credenziali delle chiavi denominato MyKeyVault e salva un backup del segreto in un file denominato Backup.blob.

Esempio 3: Eseguire il backup di un segreto recuperato in precedenza in un nome file specificato

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

C:\Backup.blob

Questo comando usa il nome e il nome dell'insieme di credenziali dell'oggetto $secret per recuperare il segreto e salvare il backup in un file denominato Backup.blob.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:False
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:AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Force

Richiede conferma prima di sovrascrivere il file di output, se presente.

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

-InputObject

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

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

-Name

Specifica il nome del segreto di cui eseguire il backup.

Tipo:String
Alias:SecretName
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 il segreto 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:False
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

PSKeyVaultSecretIdentityItem

Parametri: InputObject (ByValue)

Output

String