Backup-AzureKeyVaultKey

Mencadangkan kunci dalam brankas kunci.

Penting

Karena modul Az PowerShell sekarang memiliki semua kemampuan modul AzureRM PowerShell dan lebih banyak lagi, kami akan menghentikan modul AzureRM PowerShell pada 29 Februari 2024.

Untuk menghindari gangguan layanan, perbarui skrip Anda yang menggunakan modul AzureRM PowerShell untuk menggunakan modul Az PowerShell paling lambat 29 Februari 2024. Untuk memperbarui skrip Anda secara otomatis, ikuti panduan memulai cepat.

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 mengeskrow salinan kunci Anda, sehingga Anda memiliki salinan offline jika Anda secara tidak sengaja menghapus kunci Anda 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 di brankas bernama $key. VaultName ke file bernama Backup.blob, diam-diam menimpa file jika sudah ada.

Parameter

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Timpa file yang diberikan jika ada

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Bundel kunci untuk mencadangkan, disalurkan dari output panggilan pengambilan.

Type:PSKeyVaultKeyIdentityItem
Aliases:Key
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Name

Menentukan nama kunci yang akan dicadangkan.

Type:String
Aliases:KeyName
Position:1
Default value:None
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.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VaultName

Menentukan nama brankas kunci yang berisi kunci untuk dicadangkan.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Input

PSKeyVaultKeyIdentityItem

Parameter: InputObject (ByValue)

Output

String