Database Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-09-15

Definisi sumber daya Bicep

Jenis sumber daya databaseAccounts/sqlDatabases/clientEncryptionKeys 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.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(...)
    }
  }
}

Nilai Properti

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nama Deskripsi Nilai
Nama Nama sumber daya string (diperlukan)
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 Turunan di luar sumber daya induk.
Nama simbolis untuk sumber daya jenis: databaseAccounts/sqlDatabases
Properti Properti untuk membuat dan memperbarui ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wajib)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nama Deskripsi Nilai
Sumber daya Format JSON standar clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (diperlukan)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nama Deskripsi Nilai
enkripsiAlgoritma Algoritma enkripsi yang akan digunakan bersama dengan kunci enkripsi klien ini untuk mengenkripsi/mendekripsi data. string
Id Nama ClientEncryptionKey string
keyWrapMetadata Metadata untuk penyedia pembungkusan yang dapat digunakan untuk membongkar kunci enkripsi klien yang dibungkus. KeyWrapMetadata
wrappedDataEncryptionKey Bentuk kunci yang dibungkus (dienkripsi) yang diwakili sebagai array byte. apa pun

KeyWrapMetadata

Nama Deskripsi Nilai
algoritma Algoritma yang digunakan dalam membungkus dan membuka bungkus kunci enkripsi data. string
Nama Nama KeyEncryptionKey terkait (alias CustomerManagedKey). string
jenis ProviderName dari KeyStoreProvider. string
nilai Referensi / tautan ke KeyEncryptionKey. string

Definisi sumber daya templat ARM

Jenis sumber daya databaseAccounts/sqlDatabases/clientEncryptionKeys dapat disebarkan dengan operasi yang menargetkan:

Contoh Penggunaan

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
  "apiVersion": "2023-09-15",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Nilai Properti

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nama Deskripsi Nilai
apiVersi Versi api '2023-09-15'
Nama Nama sumber daya string (diperlukan)
Properti Properti untuk membuat dan memperbarui ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wajib)
jenis Jenis sumber daya 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nama Deskripsi Nilai
Sumber daya Format JSON standar clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (diperlukan)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nama Deskripsi Nilai
enkripsiAlgoritma Algoritma enkripsi yang akan digunakan bersama dengan kunci enkripsi klien ini untuk mengenkripsi/mendekripsi data. string
Id Nama ClientEncryptionKey string
keyWrapMetadata Metadata untuk penyedia pembungkusan yang dapat digunakan untuk membongkar kunci enkripsi klien yang dibungkus. KeyWrapMetadata
wrappedDataEncryptionKey Bentuk kunci yang dibungkus (dienkripsi) yang diwakili sebagai array byte. apa pun

KeyWrapMetadata

Nama Deskripsi Nilai
algoritma Algoritma yang digunakan dalam membungkus dan membuka bungkus kunci enkripsi data. string
Nama Nama KeyEncryptionKey terkait (alias CustomerManagedKey). string
jenis ProviderName dari KeyStoreProvider. string
nilai Referensi / tautan ke KeyEncryptionKey. string

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya databaseAccounts/sqlDatabases/clientEncryptionKeys 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.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  }
}

Nilai Properti

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nama Deskripsi Nilai
Nama Nama sumber daya string (diperlukan)
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: databaseAccounts/sqlDatabases
Properti Properti untuk membuat dan memperbarui ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (wajib)
jenis Jenis sumber daya "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15"

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nama Deskripsi Nilai
Sumber daya Format JSON standar clientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (diperlukan)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nama Deskripsi Nilai
enkripsiAlgoritma Algoritma enkripsi yang akan digunakan bersama dengan kunci enkripsi klien ini untuk mengenkripsi/mendekripsi data. string
Id Nama ClientEncryptionKey string
keyWrapMetadata Metadata untuk penyedia pembungkusan yang dapat digunakan untuk membongkar kunci enkripsi klien yang dibungkus. KeyWrapMetadata
wrappedDataEncryptionKey Bentuk kunci yang dibungkus (dienkripsi) yang diwakili sebagai array byte. apa pun

KeyWrapMetadata

Nama Deskripsi Nilai
algoritma Algoritma yang digunakan dalam membungkus dan membuka bungkus kunci enkripsi data. string
Nama Nama KeyEncryptionKey terkait (alias CustomerManagedKey). string
jenis ProviderName dari KeyStoreProvider. string
nilai Referensi / tautan ke KeyEncryptionKey. string