Backup-AzKeyVaultKey

Modul:
Az.KeyVault Module

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

Syntax

ByKeyName (Výchozí) 

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

HsmByKeyName 

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

ByKey 

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 šifrovaný, nelze 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í Key Vault a teď chcete klíč naklonovat do jiné Azure oblasti, 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íčů ve 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 cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-DefaultProfile

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

Vlastnosti parametru

Typ:IAzureContextContainer
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Force

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

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů: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í.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

HsmByKeyName
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-InputObject

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

Vlastnosti parametru

Typ:PSKeyVaultKeyIdentityItem
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Key

Sady parametrů

ByKey
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Name

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

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Název klíče

Sady parametrů

ByKeyName
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False
HsmByKeyName
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů: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.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:2
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-VaultName

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

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ByKeyName
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

PSKeyVaultKeyIdentityItem

Výstupy

String