Backup-AzureKeyVaultSecret
Mencadangkan rahasia di brankas kunci.
Peringatan
Modul AzureRM PowerShell telah resmi tidak digunakan lagi per 29 Februari 2024. Pengguna disarankan untuk bermigrasi dari AzureRM ke modul Az PowerShell untuk memastikan dukungan dan pembaruan yang berkelanjutan.
Meskipun modul AzureRM mungkin masih berfungsi, modul tersebut tidak lagi dipertahankan atau didukung, menempatkan penggunaan berkelanjutan berdasarkan kebijaksanaan dan risiko pengguna. Silakan merujuk ke sumber daya migrasi kami untuk panduan tentang transisi ke modul Az.
Sintaks
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>]
Deskripsi
Cmdlet Backup-AzureKeyVaultSecret mencadangkan rahasia tertentu dalam brankas kunci dengan mengunduhnya dan menyimpannya dalam file. Jika ada beberapa versi rahasia, semua versi disertakan dalam cadangan. Karena konten yang diunduh dienkripsi, konten tidak dapat digunakan di luar Azure Key Vault. Anda dapat memulihkan rahasia yang dicadangkan ke brankas kunci apa pun dalam langganan tempatnya dicadangkan. Alasan umum untuk menggunakan cmdlet ini adalah:
- Anda ingin mengekstrak salinan rahasia Anda, sehingga Anda memiliki salinan offline jika Anda secara tidak sengaja menghapus rahasia Anda di brankas kunci Anda.
- Anda menambahkan rahasia ke brankas kunci dan sekarang ingin mengkloning rahasia ke wilayah Azure yang berbeda, sehingga Anda dapat menggunakannya dari semua instans aplikasi terdistribusi Anda. Gunakan cmdlet Backup-AzureKeyVaultSecret untuk mengambil rahasia dalam format terenkripsi lalu gunakan cmdlet Restore-AzureKeyVaultSecret dan tentukan brankas kunci di wilayah kedua. (Perhatikan bahwa wilayah harus termasuk dalam geografi yang sama.)
Contoh
Contoh 1: Mencadangkan rahasia dengan nama file yang dihasilkan secara otomatis
PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
C:\Users\username\mykeyvault-mysecret-1527029447.01191
Perintah ini mengambil rahasia bernama MySecret dari brankas kunci bernama MyKeyVault dan menyimpan cadangan rahasia tersebut ke file yang secara otomatis dinamai untuk Anda, dan menampilkan nama file.
Contoh 2: Mencadangkan rahasia ke nama file tertentu, menimpa file yang ada tanpa meminta
PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blob
Perintah ini mengambil rahasia bernama MySecret dari brankas kunci bernama MyKeyVault dan menyimpan cadangan rahasia tersebut ke file bernama Backup.blob.
Contoh 3: Mencadangkan rahasia yang sebelumnya diambil ke nama file tertentu
PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'
C:\Backup.blob
Perintah ini menggunakan nama dan nama vault objek $secret untuk mengambil rahasia dan menyimpan cadangannya ke file bernama Backup.blob.
Parameter
-Confirm
Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.
Jenis: | SwitchParameter |
Aliases: | cf |
Position: | Named |
nilai default: | False |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure
Jenis: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Meminta konfirmasi sebelum menimpa file output, jika ada.
Jenis: | SwitchParameter |
Position: | Named |
nilai default: | False |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Rahasia yang akan dicadangkan, disalurkan dari output panggilan pengambilan.
Jenis: | PSKeyVaultSecretIdentityItem |
Aliases: | Secret |
Position: | 0 |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Menentukan nama rahasia yang akan dicadangkan.
Jenis: | String |
Aliases: | SecretName |
Position: | 1 |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-OutputFile
Menentukan file output tempat blob cadangan disimpan. Jika Anda tidak menentukan parameter ini, cmdlet ini menghasilkan nama file untuk Anda. Jika Anda menentukan nama file output yang ada, operasi tidak akan selesai dan mengembalikan pesan kesalahan bahwa file cadangan sudah ada.
Jenis: | String |
Position: | 2 |
nilai default: | None |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Menentukan nama brankas kunci yang berisi rahasia untuk dicadangkan.
Jenis: | String |
Position: | 0 |
nilai default: | None |
Diperlukan: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.
Jenis: | SwitchParameter |
Aliases: | wi |
Position: | Named |
nilai default: | False |
Diperlukan: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Input
Parameter: InputObject (ByValue)