Aracılığıyla paylaş

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-11-15

  • Makale

Bicep kaynak tanımı

databaseAccounts/sqlDatabases/clientEncryptionKeys kaynak türü, şunları hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys kaynağı oluşturmak için, şablonunuza aşağıdaki Bicep'i ekleyin.

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

Özellik değerleri

databaseAccounts/sqlDatabases/clientEncryptionKeys

Ad Açıklama Değer
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
Üst Bicep'te bir alt kaynağın üst kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.		 Kaynak türü için sembolik ad: sqlDatabases
properties ClientEncryptionKey oluşturma ve güncelleştirme özellikleri. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (gerekli)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Ad Açıklama Değer
kaynak ClientEncryptionKey'in standart JSON biçimi ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (gerekli)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Ad Açıklama Değer
Encryptionalgorithm Verileri şifrelemek/şifresini çözmek için bu istemci şifreleme anahtarıyla birlikte kullanılacak şifreleme algoritması. string
kimlik ClientEncryptionKey Adı string
keyWrapMetadata Sarmalanmış istemci şifreleme anahtarını açmak için kullanılabilecek sarmalama sağlayıcısı meta verileri. KeyWrapMetadata
wrappedDataEncryptionKey Bayt dizisi olarak temsil edilen anahtarın sarmalanmış (şifrelenmiş) biçimi. Bicep için any() işlevini kullanabilirsiniz.

KeyWrapMetadata

Ad Açıklama Değer
algoritma Veri şifreleme anahtarını sarmalama ve açma işlemlerinde kullanılan algoritma. string
name İlişkili KeyEncryptionKey'in adı (diğer adıyla CustomerManagedKey). string
tür KeyStoreProvider ProviderName. string
değer KeyEncryptionKey'e başvuru / bağlantı. string

ARM şablonu kaynak tanımı

databaseAccounts/sqlDatabases/clientEncryptionKeys kaynak türü, şunları hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

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

Özellik değerleri

databaseAccounts/sqlDatabases/clientEncryptionKeys

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'
apiVersion Kaynak API'sinin sürümü '2023-11-15'
name Kaynak adı

JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)
properties ClientEncryptionKey oluşturma ve güncelleştirme özellikleri. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (gerekli)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Ad Açıklama Değer
kaynak ClientEncryptionKey'in standart JSON biçimi ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (gerekli)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Ad Açıklama Değer
Encryptionalgorithm Verileri şifrelemek/şifresini çözmek için bu istemci şifreleme anahtarıyla birlikte kullanılacak şifreleme algoritması. string
kimlik ClientEncryptionKey Adı string
keyWrapMetadata Sarmalanmış istemci şifreleme anahtarını açmak için kullanılabilecek sarmalama sağlayıcısı meta verileri. KeyWrapMetadata
wrappedDataEncryptionKey Bayt dizisi olarak temsil edilen anahtarın sarmalanmış (şifrelenmiş) biçimi.

KeyWrapMetadata

Ad Açıklama Değer
algoritma Veri şifreleme anahtarını sarmalama ve kaldırma işlemlerinde kullanılan algoritma. string
name İlişkili KeyEncryptionKey'in adı (diğer adıyla CustomerManagedKey). string
tür KeyStoreProvider ProviderName. string
değer KeyEncryptionKey'e başvuru / bağlantı. string

Terraform (AzAPI sağlayıcısı) kaynak tanımı

databaseAccounts/sqlDatabases/clientEncryptionKeys kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys kaynağı oluşturmak için aşağıdaki Terraform'u şablonunuza ekleyin.

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

Özellik değerleri

databaseAccounts/sqlDatabases/clientEncryptionKeys

Ad Açıklama Değer
tür Kaynak türü "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15"
name Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: sqlDatabases kimliği
properties ClientEncryptionKey oluşturma ve güncelleştirme özellikleri. ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (gerekli)

ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...

Ad Açıklama Değer
kaynak ClientEncryptionKey'in standart JSON biçimi ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (gerekli)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...

Ad Açıklama Değer
Encryptionalgorithm Verileri şifrelemek/şifresini çözmek için bu istemci şifreleme anahtarıyla birlikte kullanılacak şifreleme algoritması. string
kimlik ClientEncryptionKey Adı string
keyWrapMetadata Sarmalanmış istemci şifreleme anahtarını açmak için kullanılabilecek sarmalama sağlayıcısı meta verileri. KeyWrapMetadata
wrappedDataEncryptionKey Bayt dizisi olarak temsil edilen anahtarın sarmalanmış (şifrelenmiş) biçimi.

KeyWrapMetadata

Ad Açıklama Değer
algoritma Veri şifreleme anahtarını sarmalama ve kaldırma işlemlerinde kullanılan algoritma. string
name İlişkili KeyEncryptionKey'in adı (diğer adıyla CustomerManagedKey). string
tür KeyStoreProvider ProviderName. string
değer KeyEncryptionKey'e başvuru / bağlantı. string