Condividi tramite

Backup-AzKeyVaultSecret

Modulo:
Az.KeyVault Module

Esegue il backup di un segreto in un insieme di credenziali delle chiavi.

Sintassi

BySecretName (Impostazione predefinita) 

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

BySecretUri 

Backup-AzKeyVaultSecret
    [-Id] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySecret 

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

Descrizione

Il cmdlet Backup-AzKeyVaultSecret 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 Azure diversa, in modo da poterlo usare da tutte le istanze dell'applicazione distribuita. Usare il cmdlet Backup-AzKeyVaultSecret per recuperare il segreto in formato crittografato e quindi usare il cmdlet Restore-AzKeyVaultSecret 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

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

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

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -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.

Esempio 4: Eseguire il backup di un segreto con un nome file generato automaticamente (usando Uri)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:Cfr

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-DefaultProfile

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

Proprietà dei parametri

Tipo:IAzureContextContainer
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Force

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Id

URI del segreto keyvault. Assicurarsi che il formato sia il seguente: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretId

Set di parametri

BySecretUri
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-InputObject

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

Proprietà dei parametri

Tipo:PSKeyVaultSecretIdentityItem
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:Segreto

Set di parametri

BySecret
Posizione:0
Obbligatorio:True
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Name

Specifica il nome del segreto di cui eseguire il backup.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:SecretName

Set di parametri

BySecretName
Posizione:1
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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à.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:2
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-VaultName

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

BySecretName
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-WhatIf

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:Wi

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

PSKeyVaultSecretIdentityItem

Output

String