Bagikan melalui

Brankas/kunci Microsoft.KeyVault

  • Artikel

Komentar

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.

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 mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.KeyVault/vaults/keys, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  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'
          }
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Nilai Properti

Perbuatan

Nama Deskripsi Nilai
jenis Jenis tindakan. 'beri tahu'
'putar'

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

KeyCreateParametersTags

Nama Deskripsi Nilai

KeyProperties

Nama Deskripsi Nilai
Atribut Atribut kunci. KeyAttributes
curveName Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. Default untuk EC dan kunci EC-HSM adalah P-256 '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. Default untuk kunci RSA dan RSA-HSM adalah 2048. Pengecualian dibuat untuk membawa kunci Anda sendiri (BYOK), kunci pertukaran kunci default ke 4096. 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 RotationPolicy

KeyReleasePolicy

Nama Deskripsi Nilai
contentType Jenis konten dan versi kebijakan rilis kunci tali
data Blob yang mengodekan aturan kebijakan tempat kunci dapat dirilis. tali

KeyRotationPolicyAttributes

Nama Deskripsi Nilai
expiryTime Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1Y'. tali

LifetimeAction

Nama Deskripsi Nilai
perbuatan Tindakan kebijakan rotasi kunci lifetimeAction. Tindakan
pelatuk Pemicu masa pakai kebijakan rotasi kunciAction. Pemicu

Microsoft.KeyVault/vaults/keys

Nama Deskripsi Nilai
Nama Nama sumber daya tali

Kendala:
Pola = ^[a-zA-Z0-9-]{1,127}$ (diperlukan)
ortu 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 Turunan di luar sumber daya induk.		 Nama simbolis untuk sumber daya jenis: vault
Properti Properti kunci yang akan dibuat. KeyProperties (diperlukan)
Tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat

RotationPolicy

Nama Deskripsi Nilai
Atribut Atribut kebijakan rotasi kunci. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions untuk tindakan rotasi kunci. LifetimeAction []

Pelatuk

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'. tali
timeBeforeExpiry Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1Y'. tali

Contoh Penggunaan

Sampel Mulai Cepat Azure

Templat Mulai Cepat Azure berikut ini berisi sampel Bicep untuk menyebarkan jenis sumber daya ini.

Bicep File Deskripsi
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.

Format sumber daya

Untuk membuat sumber daya Microsoft.KeyVault/vaults/keys, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "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"
          }
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Nilai Properti

Perbuatan

Nama Deskripsi Nilai
jenis Jenis tindakan. 'beri tahu'
'putar'

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

KeyCreateParametersTags

Nama Deskripsi Nilai

KeyProperties

Nama Deskripsi Nilai
Atribut Atribut kunci. KeyAttributes
curveName Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. Default untuk EC dan kunci EC-HSM adalah P-256 '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. Default untuk kunci RSA dan RSA-HSM adalah 2048. Pengecualian dibuat untuk membawa kunci Anda sendiri (BYOK), kunci pertukaran kunci default ke 4096. 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 RotationPolicy

KeyReleasePolicy

Nama Deskripsi Nilai
contentType Jenis konten dan versi kebijakan rilis kunci tali
data Blob yang mengodekan aturan kebijakan tempat kunci dapat dirilis. tali

KeyRotationPolicyAttributes

Nama Deskripsi Nilai
expiryTime Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1Y'. tali

LifetimeAction

Nama Deskripsi Nilai
perbuatan Tindakan kebijakan rotasi kunci lifetimeAction. Tindakan
pelatuk Pemicu masa pakai kebijakan rotasi kunciAction. Pemicu

Microsoft.KeyVault/vaults/keys

Nama Deskripsi Nilai
apiVersion Versi api '2024-12-01-preview'
Nama Nama sumber daya tali

Kendala:
Pola = ^[a-zA-Z0-9-]{1,127}$ (diperlukan)
Properti Properti kunci yang akan dibuat. KeyProperties (diperlukan)
Tags Tag sumber daya Kamus nama dan nilai tag. Lihat Tag dalam templat
jenis Jenis sumber daya 'Microsoft.KeyVault/vaults/keys'

RotationPolicy

Nama Deskripsi Nilai
Atribut Atribut kebijakan rotasi kunci. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions untuk tindakan rotasi kunci. LifetimeAction []

Pelatuk

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'. tali
timeBeforeExpiry Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1Y'. tali

Contoh Penggunaan

Templat Quickstart Azure

Templat Mulai Cepat Azure berikut ini menyebarkan jenis sumber daya ini.

Templat Deskripsi
Enkripsi Akun Azure Storage dengan kunci yang dikelola pelanggan

Sebarkan ke Azure 		Templat ini menyebarkan Akun Penyimpanan dengan kunci yang dikelola pelanggan untuk enkripsi yang dihasilkan dan ditempatkan di dalam Key Vault.
Membuat Kunci di Azure KeyVault

Sebarkan ke Azure 		Modul ini memungkinkan Anda membuat kunci di KeyVault yang ada.

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 mengubah log.

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@2024-12-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  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

Perbuatan

Nama Deskripsi Nilai
jenis Jenis tindakan. 'beri tahu'
'putar'

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

KeyCreateParametersTags

Nama Deskripsi Nilai

KeyProperties

Nama Deskripsi Nilai
Atribut Atribut kunci. KeyAttributes
curveName Nama kurva elips. Untuk nilai yang valid, lihat JsonWebKeyCurveName. Default untuk EC dan kunci EC-HSM adalah P-256 '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. Default untuk kunci RSA dan RSA-HSM adalah 2048. Pengecualian dibuat untuk membawa kunci Anda sendiri (BYOK), kunci pertukaran kunci default ke 4096. 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 RotationPolicy

KeyReleasePolicy

Nama Deskripsi Nilai
contentType Jenis konten dan versi kebijakan rilis kunci tali
data Blob yang mengodekan aturan kebijakan tempat kunci dapat dirilis. tali

KeyRotationPolicyAttributes

Nama Deskripsi Nilai
expiryTime Waktu kedaluwarsa untuk versi kunci baru. Ini harus dalam format ISO8601. Misalnya: 'P90D', 'P1Y'. tali

LifetimeAction

Nama Deskripsi Nilai
perbuatan Tindakan kebijakan rotasi kunci lifetimeAction. Tindakan
pelatuk Pemicu masa pakai kebijakan rotasi kunciAction. Pemicu

Microsoft.KeyVault/vaults/keys

Nama Deskripsi Nilai
Nama Nama sumber daya tali

Kendala:
Pola = ^[a-zA-Z0-9-]{1,127}$ (diperlukan)
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: vault
Properti Properti kunci yang akan dibuat. KeyProperties (diperlukan)
Tags Tag sumber daya Kamus nama dan nilai tag.
jenis Jenis sumber daya "Microsoft.KeyVault/vaults/keys@2024-12-01-preview"

RotationPolicy

Nama Deskripsi Nilai
Atribut Atribut kebijakan rotasi kunci. KeyRotationPolicyAttributes
lifetimeActions LifetimeActions untuk tindakan rotasi kunci. LifetimeAction []

Pelatuk

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'. tali
timeBeforeExpiry Durasi waktu sebelum kunci kedaluwarsa untuk memutar atau memberi tahu. Ini akan dalam format durasi ISO 8601. Misalnya: 'P90D', 'P1Y'. tali