Sdílet prostřednictvím

Backup-AzKeyVaultSecret

  • Reference
Modul:
Az.KeyVault

Zálohuje tajný kód v trezoru klíčů.

Syntaxe

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

Description

Rutina Backup-AzKeyVaultSecret zálohuje zadaný tajný kód v trezoru klíčů tak, že ho stáhne a uloží do souboru. Pokud existuje více verzí tajného kódu, jsou do zálohy zahrnuty všechny verze. Vzhledem k tomu, že stažený obsah je zašifrovaný, nejde ho použít mimo Azure Key Vault. Zálohovaný tajný klíč můžete obnovit do libovolného trezoru klíčů v předplatném, ze kterého byl zálohovaný. Mezi obvyklé důvody použití této rutiny patří:

  • Chcete uložit kopii tajného kódu do složky, abyste měli offline kopii pro případ, že omylem odstraníte tajný kód v trezoru klíčů.
  • Do trezoru klíčů jste přidali tajný kód a teď chcete naklonovat tajný kód do jiné oblasti Azure, abyste ho mohli použít ze všech instancí distribuované aplikace. Pomocí rutiny Backup-AzKeyVaultSecret načtěte tajný kód v šifrované podobě a pak použijte rutinu Restore-AzKeyVaultSecret a zadejte trezor klíčů v druhé oblasti. (Všimněte si, že oblasti musí patřit do stejné zeměpisné oblasti.)

Příklady

Příklad 1: Zálohování tajného kódu s automaticky vygenerovaným názvem souboru

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

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

Tento příkaz načte tajný kód MySecret z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto tajného kódu do souboru, který je automaticky pojmenován za vás, a zobrazí název souboru.

Příklad 2: Zálohování tajného kódu do zadaného názvu souboru, přepsání existujícího souboru bez výzvy

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

C:\Backup.blob

Tento příkaz načte tajný kód MySecret z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto tajného klíče do souboru s názvem Backup.blob.

Příklad 3: Zálohování tajného kódu dříve načteného do zadaného názvu souboru

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

C:\Backup.blob

Tento příkaz používá název a název trezoru $secret objektu k načtení tajného kódu a uložení zálohy do souboru s názvem Backup.blob.

Příklad 4: Zálohování tajného kódu s automaticky vygenerovaným názvem souboru (pomocí identifikátoru URI)

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

Parametry

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Před přepsáním výstupního souboru se zobrazí výzva k potvrzení, pokud existuje.

Typ:SwitchParameter
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Id

Identifikátor URI tajného klíče služby KeyVault. Ujistěte se, že se řídí formátem: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Typ:String
Aliasy:SecretId
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InputObject

Tajný kód, který se má zálohovat, z výstupu volání načtení.

Typ:PSKeyVaultSecretIdentityItem
Aliasy:Secret
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Určuje název tajného kódu, který se má zálohovat.

Typ:String
Aliasy:SecretName
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-OutputFile

Určuje výstupní soubor, ve kterém je uložený objekt blob zálohy. Pokud tento parametr nezadáte, tato rutina za vás vygeneruje název souboru. Pokud zadáte název existujícího výstupního souboru, operace se nedokončí a vrátí chybovou zprávu, že záložní soubor již existuje.

Typ:String
Position:2
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-VaultName

Určuje název trezoru klíčů, který obsahuje tajný kód pro zálohování.

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

PSKeyVaultSecretIdentityItem

Výstupy

String