Dela via

Backup-AzureKeyVaultSecret

  • Referens
Modul:
AzureRM.KeyVault

Säkerhetskopierar en hemlighet i ett nyckelvalv.

Varning

AzureRM PowerShell-modulen är officiellt inaktuell från och med den 29 februari 2024. Användare rekommenderas att migrera från AzureRM till Az PowerShell-modulen för att säkerställa fortsatt support och uppdateringar.

Även om AzureRM-modulen fortfarande kan fungera, underhålls den inte längre eller stöds, vilket gör att användaren kan välja och riskera fortsatt användning. Se våra migreringsresurser för vägledning om övergången till Az-modulen.

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

Cmdleten Backup-AzureKeyVaultSecret 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-AzureKeyVaultSecret för att hämta hemligheten i krypterat format och sedan använda cmdleten Restore-AzureKeyVaultSecret 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

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

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

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -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.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-DefaultProfile

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

Typ:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Force

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

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-InputObject

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

Typ:PSKeyVaultSecretIdentityItem
Alias:Secret
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Anger namnet på hemligheten som ska säkerhetskopieras.

Typ:String
Alias:SecretName
Position:1
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken: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.

Typ:String
Position:2
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-VaultName

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

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-WhatIf

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

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

PSKeyVaultSecretIdentityItem

Parametrar: InputObject (ByValue)

Utdata

String