Delen via

Backup-AzKeyVaultSecret

  • Referentie
Module:
Az.KeyVault

Maakt een back-up van een geheim in een sleutelkluis.

Syntaxis

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

Description

De cmdlet Backup-AzKeyVaultSecret maakt een back-up van een opgegeven geheim in een sleutelkluis door het te downloaden en op te slaan in een bestand. Als er meerdere versies van het geheim zijn, worden alle versies opgenomen in de back-up. Omdat de gedownloade inhoud is versleuteld, kan deze niet worden gebruikt buiten Azure Key Vault. U kunt een back-upgeheim herstellen naar elke sleutelkluis in het abonnement waarvan een back-up is gemaakt. Veelvoorkomende redenen voor het gebruik van deze cmdlet zijn:

  • U wilt een kopie van uw geheim borgen, zodat u een offlinekopie hebt voor het geval u uw geheim per ongeluk verwijdert in uw sleutelkluis.
  • U hebt een geheim toegevoegd aan een sleutelkluis en wilt het geheim nu klonen in een andere Azure-regio, zodat u het kunt gebruiken vanuit alle exemplaren van uw gedistribueerde toepassing. Gebruik de cmdlet Backup-AzKeyVaultSecret om het geheim op te halen in versleutelde indeling en gebruik vervolgens de cmdlet Restore-AzKeyVaultSecret en geef een sleutelkluis op in de tweede regio. (Houd er rekening mee dat de regio's tot dezelfde geografie moeten behoren.)

Voorbeelden

Voorbeeld 1: Een back-up maken van een geheim met een automatisch gegenereerde bestandsnaam

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

Met deze opdracht wordt het geheim met de naam MySecret opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van dat geheim opgeslagen in een bestand dat automatisch voor u wordt genoemd en wordt de bestandsnaam weergegeven.

Voorbeeld 2: Een back-up maken van een geheim naar een opgegeven bestandsnaam, het bestaande bestand overschrijven zonder dat u hierom wordt gevraagd

Backup-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Met deze opdracht wordt het geheim MySecret opgehaald uit de sleutelkluis met de naam MyKeyVault en wordt een back-up van dat geheim opgeslagen in een bestand met de naam Backup.blob.

Voorbeeld 3: Een back-up maken van een geheim dat eerder is opgehaald naar een opgegeven bestandsnaam

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

C:\Backup.blob

Deze opdracht maakt gebruik van de kluisnaam en -naam van het $secret-object om het geheim op te halen en de back-up op te slaan in een bestand met de naam Backup.blob.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Vraagt u om bevestiging voordat u het uitvoerbestand overschrijft, als dat bestaat.

Type:SwitchParameter
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-InputObject

Geheim waarvan een back-up moet worden gemaakt, gepijplijnd vanuit de uitvoer van een ophaalaanroep.

Type:PSKeyVaultSecretIdentityItem
Aliassen:Secret
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

Hiermee geeft u de naam van het geheim waarvan een back-up moet worden back-up.

Type:String
Aliassen:SecretName
Position:1
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-OutputFile

Hiermee geeft u het uitvoerbestand waarin de back-upblob wordt opgeslagen. Als u deze parameter niet opgeeft, genereert deze cmdlet een bestandsnaam voor u. Als u de naam van een bestaand uitvoerbestand opgeeft, wordt de bewerking niet voltooid en wordt er een foutbericht geretourneerd dat het back-upbestand al bestaat.

Type:String
Position:2
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-VaultName

Hiermee geeft u de naam op van de sleutelkluis die het geheim bevat waarvan een back-up moet worden gemaakt.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PSKeyVaultSecretIdentityItem

Uitvoerwaarden

String