Microsoft.KeyVault vaults/keys
Definisi sumber daya Bicep
Jenis sumber daya brankas/kunci dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Keterangan
Untuk panduan tentang menggunakan brankas kunci untuk nilai aman, lihat Mengelola rahasia dengan menggunakan Bicep.
Untuk mulai cepat membuat rahasia, lihat Mulai Cepat: Mengatur dan mengambil rahasia dari Azure Key Vault menggunakan templat ARM.
Untuk mulai cepat membuat kunci, lihat Mulai Cepat: Membuat brankas kunci Azure dan kunci dengan menggunakan templat ARM.
Format sumber daya
Untuk membuat sumber daya Microsoft.KeyVault/vaults/keys, tambahkan Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2023-07-01' = {
name: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
attributes: {
enabled: bool
exp: int
exportable: bool
nbf: int
}
curveName: 'string'
keyOps: [
'string'
]
keySize: int
kty: 'string'
release_policy: {
contentType: 'string'
data: 'string'
}
rotationPolicy: {
attributes: {
expiryTime: 'string'
}
lifetimeActions: [
{
action: {
type: 'string'
}
trigger: {
timeAfterCreate: 'string'
timeBeforeExpiry: 'string'
}
}
]
}
}
}
Nilai properti
vault/keys
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | Nama sumber daya Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep. |
string (diperlukan) |
| tag | Tag yang akan ditetapkan ke kunci. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| induk | Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk. Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk. |
Nama simbolis untuk sumber daya jenis: vault |
| properti | Properti kunci yang akan dibuat. | KeyProperties (diperlukan) |
KeyProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kunci. | KeyAttributes |
| curveName | Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. | 'P-256' 'P-256K' 'P-384' 'P-521' |
| keyOps | Array string yang berisi salah satu dari: 'dekripsi' 'enkripsi' 'impor' 'rilis' 'tanda tangan' 'unwrapKey' 'verifikasi' 'wrapKey' |
|
| keySize | Ukuran kunci dalam bit. Misalnya: 2048, 3072, atau 4096 untuk RSA. | int |
| kty | Jenis kunci. Untuk nilai yang valid, lihat JsonWebKeyType. | 'EC' 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Kebijakan rilis kunci sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | KeyReleasePolicy |
| rotationPolicy | Kebijakan rotasi kunci sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | RotationPolicy |
KeyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| diaktifkan | Menentukan apakah objek diaktifkan atau tidak. | bool |
| exp | Tanggal kedaluwarsa dalam detik sejak 1970-01-01T00:00:00Z. | int |
| Ekspor | Menunjukkan apakah kunci privat dapat diekspor. | bool |
| nbf | Tidak sebelum tanggal dalam detik sejak 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| contentType | Jenis konten dan versi kebijakan rilis kunci | string |
| data | Pengodean blob aturan kebijakan di mana kunci dapat dirilis. | string |
RotasiPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kebijakan rotasi kunci. | KeyRotationPolicyAttributes |
| lifetimeActions | LifetimeActions untuk tindakan rotasi kunci. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| expiryTime | Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1y'. | string |
LifetimeAction
| Nama | Deskripsi | Nilai |
|---|---|---|
| tindakan | Tindakan kebijakan rotasi kunci lifetimeAction. | Tindakan |
| pemicu | Pemicu kebijakan rotasi kunci lifetimeAction. | Pemicu |
Tindakan
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis tindakan. | 'beri tahu' 'putar' |
Pemicu
| Nama | Deskripsi | Nilai |
|---|---|---|
| timeAfterCreate | Durasi waktu setelah pembuatan kunci untuk memutar kunci. Ini hanya berlaku untuk memutar. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1y'. | string |
| timeBeforeExpiry | Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1y'. | string |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
Membuat Kunci di Azure KeyVault |
Modul ini memungkinkan Anda membuat kunci di KeyVault yang ada. |
| Enkripsi Akun Azure Storage dengan kunci yang dikelola pelanggan |
Templat ini menyebarkan Akun Penyimpanan dengan kunci yang dikelola pelanggan untuk enkripsi yang dihasilkan dan ditempatkan di dalam Key Vault. |
Definisi sumber daya templat ARM
Jenis sumber daya brankas/kunci dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.
Keterangan
Untuk panduan tentang menggunakan brankas kunci untuk nilai aman, lihat Mengelola rahasia dengan menggunakan Bicep.
Untuk mulai cepat membuat rahasia, lihat Mulai Cepat: Mengatur dan mengambil rahasia dari Azure Key Vault menggunakan templat ARM.
Untuk mulai cepat membuat kunci, lihat Mulai Cepat: Membuat brankas kunci Azure dan kunci dengan menggunakan templat ARM.
Format sumber daya
Untuk membuat sumber daya Microsoft.KeyVault/vaults/keys, tambahkan JSON berikut ke templat Anda.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2023-07-01",
"name": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"exportable": "bool",
"nbf": "int"
},
"curveName": "string",
"keyOps": [ "string" ],
"keySize": "int",
"kty": "string",
"release_policy": {
"contentType": "string",
"data": "string"
},
"rotationPolicy": {
"attributes": {
"expiryTime": "string"
},
"lifetimeActions": [
{
"action": {
"type": "string"
},
"trigger": {
"timeAfterCreate": "string",
"timeBeforeExpiry": "string"
}
}
]
}
}
}
Nilai properti
vaults/keys
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | 'Microsoft.KeyVault/vaults/keys' |
| apiVersion | Versi api sumber daya | '2023-07-01' |
| nama | Nama sumber daya Lihat cara mengatur nama dan jenis untuk sumber daya anak di templat JSON ARM. |
string (diperlukan) |
| tag | Tag yang akan ditetapkan ke kunci. | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| properti | Properti kunci yang akan dibuat. | KeyProperties (diperlukan) |
KeyProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kunci. | KeyAttributes |
| curveName | Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. | 'P-256' 'P-256K' 'P-384' 'P-521' |
| keyOps | Array string yang berisi salah satu dari: 'dekripsi' 'enkripsi' 'impor' 'rilis' 'tanda' 'unwrapKey' 'verifikasi' 'wrapKey' |
|
| keySize | Ukuran kunci dalam bit. Misalnya: 2048, 3072, atau 4096 untuk RSA. | int |
| kty | Jenis kunci. Untuk nilai yang valid, lihat JsonWebKeyType. | 'EC' 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Kebijakan rilis utama sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | KeyReleasePolicy |
| rotationPolicy | Kebijakan rotasi kunci sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | RotasiPolicy |
KeyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| diaktifkan | Menentukan apakah objek diaktifkan atau tidak. | bool |
| exp | Tanggal kedaluwarsa dalam detik sejak 1970-01-01T00:00:00Z. | int |
| Ekspor | Menunjukkan apakah kunci privat dapat diekspor. | bool |
| nbf | Tidak sebelum tanggal dalam detik sejak 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| contentType | Jenis konten dan versi kebijakan rilis kunci | string |
| data | Pengodean blob aturan kebijakan di mana kunci dapat dirilis. | string |
RotasiPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kebijakan rotasi kunci. | KeyRotationPolicyAttributes |
| lifetimeActions | LifetimeActions untuk tindakan rotasi kunci. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| expiryTime | Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1Y'. | string |
LifetimeAction
| Nama | Deskripsi | Nilai |
|---|---|---|
| tindakan | Tindakan kebijakan rotasi kunci seumur hidupAction. | Tindakan |
| pemicu | Pemicu lifetimeAction kebijakan rotasi kunci. | Pemicu |
Tindakan
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis tindakan. | 'beri tahu' 'putar' |
Pemicu
| Nama | Deskripsi | Nilai |
|---|---|---|
| timeAfterCreate | Durasi waktu setelah pembuatan kunci untuk memutar kunci. Ini hanya berlaku untuk memutar. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1Y'. | string |
| timeBeforeExpiry | Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1Y'. | string |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
| Membuat Kunci di Azure KeyVault |
Modul ini memungkinkan Anda membuat kunci di KeyVault yang ada. |
| Enkripsi Akun Azure Storage dengan kunci yang dikelola pelanggan |
Templat ini menyebarkan Akun Penyimpanan dengan kunci yang dikelola pelanggan untuk enkripsi yang dihasilkan dan ditempatkan di dalam Key Vault. |
Definisi sumber daya Terraform (penyedia AzAPI)
Jenis sumber daya brankas/kunci dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.KeyVault/vaults/keys, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2023-07-01"
name = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
exportable = bool
nbf = int
}
curveName = "string"
keyOps = [
"string"
]
keySize = int
kty = "string"
release_policy = {
contentType = "string"
data = "string"
}
rotationPolicy = {
attributes = {
expiryTime = "string"
}
lifetimeActions = [
{
action = {
type = "string"
}
trigger = {
timeAfterCreate = "string"
timeBeforeExpiry = "string"
}
}
]
}
}
})
}
Nilai properti
vault/keys
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | "Microsoft.KeyVault/vaults/keys@2023-07-01" |
| nama | Nama sumber daya | string (diperlukan) |
| parent_id | ID sumber daya yang merupakan induk untuk sumber daya ini. | ID untuk sumber daya jenis: vault |
| tag | Tag yang akan ditetapkan ke kunci. | Kamus nama dan nilai tag. |
| properti | Properti kunci yang akan dibuat. | KeyProperties (diperlukan) |
KeyProperties
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kunci. | KeyAttributes |
| curveName | Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. | "P-256" "P-256K" "P-384" "P-521" |
| keyOps | Array string yang berisi salah satu dari: "dekripsi" "enkripsi" "impor" "rilis" "sign" "unwrapKey" "verifikasi" "wrapKey" |
|
| keySize | Ukuran kunci dalam bit. Misalnya: 2048, 3072, atau 4096 untuk RSA. | int |
| kty | Jenis kunci. Untuk nilai yang valid, lihat JsonWebKeyType. | "EC" "EC-HSM" "RSA" "RSA-HSM" |
| release_policy | Kebijakan rilis utama sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | KeyReleasePolicy |
| rotationPolicy | Kebijakan rotasi kunci sebagai respons. Ini akan digunakan untuk output dan input. Dihilangkan jika kosong | RotasiPolicy |
KeyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| diaktifkan | Menentukan apakah objek diaktifkan atau tidak. | bool |
| exp | Tanggal kedaluwarsa dalam detik sejak 1970-01-01T00:00:00Z. | int |
| Ekspor | Menunjukkan apakah kunci privat dapat diekspor. | bool |
| nbf | Tidak sebelum tanggal dalam detik sejak 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| contentType | Jenis konten dan versi kebijakan rilis kunci | string |
| data | Pengodean blob aturan kebijakan di mana kunci dapat dirilis. | string |
RotasiPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| Atribut | Atribut kebijakan rotasi kunci. | KeyRotationPolicyAttributes |
| lifetimeActions | LifetimeActions untuk tindakan rotasi kunci. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Nama | Deskripsi | Nilai |
|---|---|---|
| expiryTime | Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1y'. | string |
LifetimeAction
| Nama | Deskripsi | Nilai |
|---|---|---|
| tindakan | Tindakan kebijakan rotasi kunci lifetimeAction. | Tindakan |
| pemicu | Pemicu kebijakan rotasi kunci lifetimeAction. | Pemicu |
Tindakan
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis tindakan. | "beri tahu" "putar" |
Pemicu
| Nama | Deskripsi | Nilai |
|---|---|---|
| timeAfterCreate | Durasi waktu setelah pembuatan kunci untuk memutar kunci. Ini hanya berlaku untuk memutar. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1y'. | string |
| timeBeforeExpiry | Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1y'. | string |
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk