Backup-AzureKeyVaultKey
Mencadangkan kunci 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-AzureKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Backup-AzureKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-OutputFile] <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Deskripsi
Cmdlet Backup-AzureKeyVaultKey mencadangkan kunci tertentu dalam brankas kunci dengan mengunduhnya dan menyimpannya dalam file. Jika ada beberapa versi kunci, semua versi disertakan dalam cadangan. Karena konten yang diunduh dienkripsi, konten tidak dapat digunakan di luar Azure Key Vault. Anda dapat memulihkan kunci yang dicadangkan ke brankas kunci apa pun dalam langganan tempat kunci tersebut dicadangkan. Alasan umum untuk menggunakan cmdlet ini adalah:
Anda ingin memasukkan salinan kunci Anda, sehingga Anda memiliki salinan offline jika Anda secara tidak sengaja menghapus kunci di brankas kunci Anda.
Anda membuat kunci menggunakan Key Vault dan sekarang ingin mengkloning kunci ke wilayah Azure yang berbeda, sehingga Anda dapat menggunakannya dari semua instans aplikasi terdistribusi Anda. Gunakan cmdlet Backup-AzureKeyVaultKey untuk mengambil kunci dalam format terenkripsi lalu gunakan cmdlet Restore-AzureKeyVaultKey dan tentukan brankas kunci di wilayah kedua.
Contoh
Contoh 1: Mencadangkan kunci dengan nama file yang dihasilkan secara otomatis
PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
C:\Users\username\mykeyvault-mykey-1527029447.01191
Perintah ini mengambil kunci bernama MyKey dari brankas kunci bernama MyKeyVault dan menyimpan cadangan kunci tersebut ke file yang secara otomatis dinamai untuk Anda, dan menampilkan nama file.
Contoh 2: Mencadangkan kunci ke nama file tertentu
PS C:\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'
C:\Backup.blob
Perintah ini mengambil kunci bernama MyKey dari brankas kunci bernama MyKeyVault dan menyimpan cadangan kunci tersebut ke file bernama Backup.blob.
Contoh 3: Cadangkan kunci yang diambil sebelumnya ke nama file tertentu, menimpa file tujuan tanpa meminta.
PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force
C:\Backup.blob
Perintah ini membuat cadangan kunci bernama $key. Nama dalam vault bernama $key. VaultName ke file bernama Backup.blob, secara diam-diam menimpa file jika sudah ada.
Parameter
-Confirm
Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.
Jenis: | SwitchParameter |
Alias: | cf |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-DefaultProfile
Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure
Jenis: | IAzureContextContainer |
Alias: | AzureRmContext, AzureCredential |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-Force
Timpa file yang diberikan jika ada
Jenis: | SwitchParameter |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
-InputObject
Bundel kunci untuk mencadangkan, disalurkan dari output panggilan pengambilan.
Jenis: | PSKeyVaultKeyIdentityItem |
Alias: | Key |
Position: | 0 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | True |
Terima karakter wildcard: | False |
-Name
Menentukan nama kunci yang akan dicadangkan.
Jenis: | String |
Alias: | KeyName |
Position: | 1 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | False |
Terima karakter wildcard: | 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 |
Terima input alur: | False |
Terima karakter wildcard: | False |
-VaultName
Menentukan nama brankas kunci yang berisi kunci untuk dicadangkan.
Jenis: | String |
Position: | 0 |
Nilai default: | None |
Diperlukan: | True |
Terima input alur: | False |
Terima karakter wildcard: | False |
-WhatIf
Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.
Jenis: | SwitchParameter |
Alias: | wi |
Position: | Named |
Nilai default: | None |
Diperlukan: | False |
Terima input alur: | False |
Terima karakter wildcard: | False |
Input
Parameter: InputObject (ByValue)