Backup-AzureKeyVaultSecret
Wykonuje kopię zapasową wpisu tajnego w magazynie kluczy.
Ostrzeżenie
Moduł AzureRM PowerShell został oficjalnie przestarzały od 29 lutego 2024 r. Zaleca się migrowanie użytkowników z modułu AzureRM do modułu Az programu PowerShell w celu zapewnienia ciągłej obsługi i aktualizacji.
Mimo że moduł AzureRM może nadal działać, nie jest już utrzymywany ani obsługiwany, umieszczając wszelkie dalsze zastosowania według uznania i ryzyka użytkownika. Zapoznaj się z naszymi zasobami migracji, aby uzyskać wskazówki dotyczące przejścia do modułu Az.
Składnia
Backup-AzureKeyVaultSecret
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Backup-AzureKeyVaultSecret
[-InputObject] <PSKeyVaultSecretIdentityItem>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Opis
Polecenie cmdlet Backup-AzureKeyVaultSecret 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-AzureKeyVaultSecret, aby pobrać wpis tajny w formacie zaszyfrowanym, a następnie użyć polecenia cmdlet Restore-AzureKeyVaultSecret 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
PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
C:\Users\username\mykeyvault-mysecret-1527029447.01191To 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
PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blobTo 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
PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'
C:\Backup.blobTo polecenie używa nazwy i nazwy magazynu obiektu $secret, aby pobrać wpis tajny i zapisać jego kopię zapasową w pliku o nazwie Backup.blob.
Parametry
-Confirm
Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| 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: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Monituje o potwierdzenie przed zastąpieniem pliku wyjściowego, jeśli istnieje.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Wpis tajny do utworzenia kopii zapasowej potoku z danych wyjściowych wywołania pobierania.
| Type: | PSKeyVaultSecretIdentityItem |
| Aliases: | Secret |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Określa nazwę wpisu tajnego do utworzenia kopii zapasowej.
| Type: | String |
| Aliases: | SecretName |
| 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 wpis tajny 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Dane wejściowe
Parametry: InputObject (ByValue)