Backup-AzureKeyVaultSecret

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

Waarschuwing

De AzureRM PowerShell-module is vanaf 29 februari 2024 officieel afgeschaft. Gebruikers wordt aangeraden om van AzureRM naar de Az PowerShell-module te migreren om ondersteuning en updates te garanderen.

Hoewel de AzureRM-module nog steeds kan functioneren, wordt deze niet meer onderhouden of ondersteund, waardoor het gebruik naar eigen goeddunken en risico van de gebruiker blijft bestaan. Raadpleeg onze migratiebronnen voor hulp bij de overgang naar de Az-module.

Syntax

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

Description

De cmdlet Backup-AzureKeyVaultSecret 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-AzureKeyVaultSecret om het geheim op te halen in versleutelde indeling en gebruik vervolgens de cmdlet Restore-AzureKeyVaultSecret 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

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

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

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -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
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

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

-Force

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

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

-InputObject

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

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

-Name

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

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

-WhatIf

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

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

Invoerwaarden

PSKeyVaultSecretIdentityItem

Parameters: InputObject (ByValue)

Uitvoerwaarden

String