Backup-AzureKeyVaultSecret
Zálohuje tajný kód v trezoru klíčů.
Upozorňující
Modul AzureRM PowerShell byl od 29. února 2024 oficiálně zastaralý. Uživatelům se doporučuje migrovat z AzureRM do modulu Az PowerShell, aby se zajistila nepřetržitá podpora a aktualizace.
I když může modul AzureRM stále fungovat, už se neudržuje ani nepodporuje, přičemž jakékoli další použití se bude umisťovat podle vlastního uvážení a rizika uživatele. Pokyny k přechodu na modul Az najdete v našich zdrojích informací o migraci.
Syntax
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>] Description
Rutina Backup-AzureKeyVaultSecret zálohuje zadaný tajný klíč do trezoru klíčů tak, že ho stáhne a uloží do souboru. Pokud existuje více verzí tajného kódu, jsou do zálohy zahrnuty všechny verze. Vzhledem k tomu, že stažený obsah je zašifrovaný, nejde ho použít mimo Azure Key Vault. Zálohovaný tajný 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 tajného kódu do složky, abyste měli offline kopii pro případ, že omylem odstraníte tajný kód v trezoru klíčů.
- Do trezoru klíčů jste přidali tajný kód a teď chcete naklonovat tajný kód do jiné oblasti Azure, abyste ho mohli použít ze všech instancí distribuované aplikace. Pomocí rutiny Backup-AzureKeyVaultSecret načtěte tajný kód v šifrované podobě a pak použijte rutinu Restore-AzureKeyVaultSecret a zadejte trezor klíčů ve druhé oblasti. (Všimněte si, že oblasti musí patřit do stejné zeměpisné oblasti.)
Příklady
Příklad 1: Zálohování tajného kódu s automaticky vygenerovaným názvem souboru
PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
C:\Users\username\mykeyvault-mysecret-1527029447.01191Tento příkaz načte tajný kód MySecret z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto tajného kódu do souboru, který je automaticky pojmenován za vás, a zobrazí název souboru.
Příklad 2: Zálohování tajného kódu do zadaného názvu souboru, přepsání existujícího souboru bez výzvy
PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blobTento příkaz načte tajný kód MySecret z trezoru klíčů s názvem MyKeyVault a uloží zálohu tohoto tajného klíče do souboru s názvem Backup.blob.
Příklad 3: Zálohování tajného kódu dříve načteného do zadaného názvu souboru
PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'
C:\Backup.blobTento příkaz používá název a název trezoru $secret objektu k načtení tajného kódu a uložení zálohy do souboru s názvem Backup.blob.
Parametry
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| 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: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Před přepsáním výstupního souboru se zobrazí výzva k potvrzení, pokud existuje.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Tajný kód, který se má zálohovat, z výstupu volání načtení.
| Type: | PSKeyVaultSecretIdentityItem |
| Aliases: | Secret |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Určuje název tajného kódu, který se má zálohovat.
| Type: | String |
| Aliases: | SecretName |
| 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 tajný kód pro zálohování.
| 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: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Vstupy
Parametry: InputObject (ByValue)