Backup-AzKeyVaultKey

Modul:
Az.KeyVault Module

Mencadangkan kunci di brankas kunci.

Sintaks

ByKeyName (Default) 

Backup-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmByKeyName 

Backup-AzKeyVaultKey
    [-Name] <String>
    [[-OutputFile] <String>]
    -HsmName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKey 

Backup-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

Cmdlet Backup-AzKeyVaultKey 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-AzKeyVaultKey untuk mengambil kunci dalam format terenkripsi lalu gunakan cmdlet Restore-AzKeyVaultKey dan tentukan brankas kunci di wilayah kedua.

Contoh

Contoh 1: Mencadangkan kunci dengan nama file yang dihasilkan secara otomatis

Backup-AzKeyVaultKey -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

Backup-AzKeyVaultKey -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.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -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 konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Cf

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-DefaultProfile

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

Properti parameter

Jenis:IAzureContextContainer
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Force

Timpa file yang diberikan jika ada

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-HsmName

Nama HSM. Cmdlet membangun FQDN dari HSM terkelola berdasarkan nama dan lingkungan yang saat ini dipilih.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

HsmByKeyName
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-InputObject

Bundel kunci untuk mencadangkan, disalurkan dari output panggilan pengambilan.

Properti parameter

Jenis:PSKeyVaultKeyIdentityItem
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Kunci

Kumpulan parameter

ByKey
Position:0
Wajib:True
Nilai dari alur:True
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Name

Menentukan nama kunci yang akan dicadangkan.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Nama Kunci

Kumpulan parameter

ByKeyName
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False
HsmByKeyName
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-VaultName

Menentukan nama brankas kunci yang berisi kunci untuk dicadangkan.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

ByKeyName
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:wi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

PSKeyVaultKeyIdentityItem

Output

String