Udostępnij za pośrednictwem

Backup-AzKeyVaultSecret

  • Odwołanie
Moduł:
Az.KeyVault

Wykonuje kopię zapasową wpisu tajnego w magazynie kluczy.

Składnia

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

Opis

Polecenie cmdlet Backup-AzKeyVaultSecret tworzy kopię zapasową określonego wpisu tajnego w magazynie kluczy, pobierając go i przechowując w pliku. Jeśli istnieje wiele wersji wpisu tajnego, 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ć wpis tajny 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ę wpisu tajnego, aby mieć kopię w trybie offline na wypadek przypadkowego usunięcia wpisu tajnego w magazynie kluczy.
  • Dodano wpis tajny do magazynu kluczy, a teraz chcesz sklonować wpis tajny do innego regionu platformy Azure, aby można było go używać ze wszystkich wystąpień aplikacji rozproszonej. Użyj polecenia cmdlet Backup-AzKeyVaultSecret, aby pobrać wpis tajny w formacie zaszyfrowanym, a następnie użyć polecenia cmdlet Restore-AzKeyVaultSecret i określić magazyn kluczy w drugim regionie. (Należy pamiętać, że regiony muszą należeć do tej samej lokalizacji geograficznej).

Przykłady

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

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

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

To polecenie pobiera wpis tajny o nazwie MySecret z magazynu kluczy o nazwie MyKeyVault i zapisuje kopię zapasową tego wpisu tajnego w pliku, który jest automatycznie nazwany i wyświetla nazwę pliku.

Przykład 2. Tworzenie kopii zapasowej wpisu tajnego do określonej nazwy pliku, zastępowanie istniejącego pliku bez monitowania

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

C:\Backup.blob

To polecenie pobiera wpis tajny o nazwie MySecret z magazynu kluczy o nazwie MyKeyVault i zapisuje kopię zapasową tego wpisu tajnego w pliku o nazwie Backup.blob.

Przykład 3. Tworzenie kopii zapasowej wpisu tajnego pobranego wcześniej pod określoną nazwą pliku

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

C:\Backup.blob

To polecenie używa nazwy i nazwy magazynu obiektu $secret, aby pobrać wpis tajny i zapisać jego kopię zapasową w pliku o nazwie Backup.blob.

Przykład 4. Tworzenie kopii zapasowej wpisu tajnego przy użyciu automatycznie wygenerowanej nazwy pliku (przy użyciu identyfikatora URI)

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

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

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

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Force

Monituje o potwierdzenie przed zastąpieniem pliku wyjściowego, jeśli istnieje.

Typ:SwitchParameter
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Id

Identyfikator URI wpisu tajnego usługi KeyVault. Upewnij się, że jest on zgodny z formatem: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Typ:String
Aliasy:SecretId
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-InputObject

Wpis tajny do utworzenia kopii zapasowej potoku z danych wyjściowych wywołania pobierania.

Typ:PSKeyVaultSecretIdentityItem
Aliasy:Secret
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwę wpisu tajnego do utworzenia kopii zapasowej.

Typ:String
Aliasy:SecretName
Position:1
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:String
Position:2
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-VaultName

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

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

PSKeyVaultSecretIdentityItem

Dane wyjściowe

String