Backup-AzKeyVaultKey

  • Reference
Modul:
Az.KeyVault

Zálohuje klíč v trezoru klíčů.

Syntax

Backup-AzKeyVaultKey
      [-VaultName] <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultKey
      -HsmName <String>
      [-Name] <String>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Backup-AzKeyVaultKey
      [-InputObject] <PSKeyVaultKeyIdentityItem>
      [[-OutputFile] <String>]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Rutina Backup-AzKeyVaultKey zálohuje zadaný klíč v trezoru klíčů tak, že ho stáhne a uloží do souboru. Pokud existuje více verzí klíče, všechny verze se zahrnou do zálohy. Vzhledem k tomu, že stažený obsah je zašifrovaný, nejde ho použít mimo Azure Key Vault. Zálohovaný 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 klíče do složky, abyste měli offline kopii pro případ, že klíč omylem odstraníte v trezoru klíčů.

  • Vytvořili jste klíč pomocí služby Key Vault a teď chcete klíč naklonovat do jiné oblasti Azure, abyste ho mohli použít ze všech instancí distribuované aplikace. Pomocí rutiny Backup-AzKeyVaultKey načtěte klíč v šifrované podobě a pak použijte rutinu Restore-AzKeyVaultKey a zadejte trezor klíčů v druhé oblasti.

Příklady

Příklad 1: Zálohování klíče s automaticky vygenerovaným názvem souboru

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

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

Tento příkaz načte klíč MyKey z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto klíče do souboru, který je automaticky pojmenovaný za vás, a zobrazí název souboru.

Příklad 2: Zálohování klíče do zadaného názvu souboru

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Tento příkaz načte klíč MyKey z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto klíče do souboru s názvem Backup.blob.

Příklad 3: Zálohujte dříve načtený klíč do zadaného názvu souboru a přepíšete cílový soubor bez výzvy.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Tento příkaz vytvoří zálohu klíče s názvem $key. Název v trezoru s názvem $key VaultName do souboru s názvem Backup.blob, bezobslužně přepíše soubor, pokud už existuje.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-DefaultProfile

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

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

-Force

Přepište daný soubor, pokud existuje.

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

-HsmName

Název HSM. Rutina vytvoří plně kvalifikovaný název domény spravovaného HSM na základě názvu a aktuálně vybraného prostředí.

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

-InputObject

Key bundle to back up, pipelined in from the output of a retrieval call.

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

-Name

Určuje název klíče, který se má zálohovat.

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

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

-VaultName

Určuje název trezoru klíčů, který obsahuje klíč, který se má zálohovat.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

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

Vstupy

PSKeyVaultKeyIdentityItem

Výstupy

String