Backup-AzKeyVaultSecret

  • Referens
Modul:
Az.KeyVault

Säkerhetskopierar en hemlighet i ett nyckelvalv.

Syntax

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

Cmdleten Backup-AzKeyVaultSecret säkerhetskopierar en angiven hemlighet i ett nyckelvalv genom att ladda ned den och lagra den i en fil. Om det finns flera versioner av hemligheten ingår alla versioner i säkerhetskopian. Eftersom det nedladdade innehållet är krypterat kan det inte användas utanför Azure Key Vault. Du kan återställa en säkerhetskopierad hemlighet till valfritt nyckelvalv i prenumerationen som den säkerhetskopierades från. Vanliga orsaker till att använda den här cmdleten är:

  • Du vill desponera en kopia av din hemlighet, så att du har en offlinekopia om du av misstag tar bort din hemlighet i nyckelvalvet.
  • Du har lagt till en hemlighet i ett nyckelvalv och vill nu klona hemligheten till en annan Azure-region, så att du kan använda den från alla instanser av ditt distribuerade program. Använd cmdleten Backup-AzKeyVaultSecret för att hämta hemligheten i krypterat format och sedan använda cmdleten Restore-AzKeyVaultSecret och ange ett nyckelvalv i den andra regionen. (Observera att regionerna måste tillhöra samma geografiska område.)

Exempel

Exempel 1: Säkerhetskopiera en hemlighet med ett automatiskt genererat filnamn

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

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

Det här kommandot hämtar hemligheten MySecret från nyckelvalvet med namnet MyKeyVault och sparar en säkerhetskopia av hemligheten till en fil som automatiskt namnges åt dig och visar filnamnet.

Exempel 2: Säkerhetskopiera en hemlighet till ett angivet filnamn, skriva över den befintliga filen utan att fråga

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

C:\Backup.blob

Det här kommandot hämtar hemligheten MySecret från nyckelvalvet MyKeyVault och sparar en säkerhetskopia av hemligheten i en fil med namnet Backup.blob.

Exempel 3: Säkerhetskopiera en hemlighet som tidigare hämtats till ett angivet filnamn

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

C:\Backup.blob

Det här kommandot använder $secret-objektets valvnamn och namn för att hämta hemligheten och sparar säkerhetskopian i en fil med namnet Backup.blob.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

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

-Force

Uppmanar dig att bekräfta innan du skriver över utdatafilen, om det finns.

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

-InputObject

Hemlighet som ska säkerhetskopieras, pipelines in från utdata från ett hämtningsanrop.

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

-Name

Anger namnet på hemligheten som ska säkerhetskopieras.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OutputFile

Anger den utdatafil där säkerhetskopieringsbloben lagras. Om du inte anger den här parametern genererar den här cmdleten ett filnamn åt dig. Om du anger namnet på en befintlig utdatafil slutförs inte åtgärden och returnerar ett felmeddelande om att säkerhetskopieringsfilen redan finns.

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

-VaultName

Anger namnet på nyckelvalvet som innehåller hemligheten som ska säkerhetskopieras.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

PSKeyVaultSecretIdentityItem

Utdata

String