Backup-AzKeyVaultKey

  • Odwołanie
Moduł:
Az.KeyVault

Wykonuje kopię zapasową klucza w magazynie kluczy.

Składnia

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>]

Opis

Polecenie cmdlet Backup-AzKeyVaultKey tworzy kopię zapasową określonego klucza w magazynie kluczy, pobierając go i przechowując w pliku. Jeśli istnieje wiele wersji klucza, wszystkie wersje są uwzględniane w kopii zapasowej. Ponieważ pobrana zawartość jest szyfrowana, nie można jej używać poza usługą Azure Key Vault. Możesz przywrócić klucz kopii zapasowej do dowolnego magazynu kluczy w subskrypcji, z której utworzono kopię zapasową. Typowe przyczyny użycia tego polecenia cmdlet to:

  • Chcesz deponować kopię klucza, aby mieć kopię w trybie offline na wypadek przypadkowego usunięcia klucza w magazynie kluczy.

  • Klucz został utworzony przy użyciu usługi Key Vault, a teraz chcesz sklonować klucz do innego regionu świadczenia usługi Azure, aby można było go używać ze wszystkich wystąpień aplikacji rozproszonej. Użyj polecenia cmdlet Backup-AzKeyVaultKey, aby pobrać klucz w formacie zaszyfrowanym, a następnie użyć polecenia cmdlet Restore-AzKeyVaultKey i określić magazyn kluczy w drugim regionie.

Przykłady

Przykład 1. Tworzenie kopii zapasowej klucza z automatycznie wygenerowaną nazwą pliku

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

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

To polecenie pobiera klucz o nazwie MyKey z magazynu kluczy o nazwie MyKeyVault i zapisuje kopię zapasową tego klucza w pliku, który jest automatycznie nazwany i wyświetla nazwę pliku.

Przykład 2. Tworzenie kopii zapasowej klucza do określonej nazwy pliku

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

C:\Backup.blob

To polecenie pobiera klucz o nazwie MyKey z magazynu kluczy o nazwie MyKeyVault i zapisuje kopię zapasową tego klucza w pliku o nazwie Backup.blob.

Przykład 3. Wykonaj kopię zapasową wcześniej pobranego klucza do określonej nazwy pliku, zastępując plik docelowy bez monitowania.

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

C:\Backup.blob

To polecenie tworzy kopię zapasową klucza o nazwie $key. Nazwa w magazynie o nazwie $key. VaultName do pliku o nazwie Backup.blob, dyskretnie zastępując plik, jeśli już istnieje.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure

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

-Force

Zastąp dany plik, jeśli istnieje

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

-HsmName

Nazwa modułu HSM. Polecenie cmdlet tworzy nazwę FQDN zarządzanego modułu HSM na podstawie nazwy i aktualnie wybranego środowiska.

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

-InputObject

Pakiet kluczy do utworzenia kopii zapasowej potoku z danych wyjściowych wywołania pobierania.

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

-Name

Określa nazwę klucza do utworzenia kopii zapasowej.

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

-OutputFile

Określa plik wyjściowy, w którym jest przechowywany obiekt blob kopii zapasowej. Jeśli nie określisz tego parametru, to polecenie cmdlet generuje nazwę pliku. Jeśli określisz nazwę istniejącego pliku wyjściowego, operacja nie zostanie ukończona i zwróci komunikat o błędzie informujący, że plik kopii zapasowej już istnieje.

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

-VaultName

Określa nazwę magazynu kluczy, który zawiera klucz do utworzenia kopii zapasowej.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

PSKeyVaultKeyIdentityItem

Dane wyjściowe

String