Share via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2024-05-15

  • Article

Bicep resource definition

The databaseAccounts/sqlDatabases/clientEncryptionKeys resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        algorithm: 'string'
        name: 'string'
        type: 'string'
        value: 'string'
      }
      wrappedDataEncryptionKey: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
}

Property values

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Description Value
resource The standard JSON format of a ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (required)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Description Value
encryptionAlgorithm Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. string
id Name of the ClientEncryptionKey string
keyWrapMetadata Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key. KeyWrapMetadata
wrappedDataEncryptionKey Wrapped (encrypted) form of the key represented as a byte array. any

KeyWrapMetadata

Name Description Value
algorithm Algorithm used in wrapping and unwrapping of the data encryption key. string
name The name of associated KeyEncryptionKey (aka CustomerManagedKey). string
type ProviderName of KeyStoreProvider. string
value Reference / link to the KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts/sqlDatabases
properties Properties to create and update ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (required)

ARM template resource definition

The databaseAccounts/sqlDatabases/clientEncryptionKeys resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys resource, add the following JSON to your template.

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

Property values

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Description Value
resource The standard JSON format of a ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (required)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Description Value
encryptionAlgorithm Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. string
id Name of the ClientEncryptionKey string
keyWrapMetadata Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key. KeyWrapMetadata
wrappedDataEncryptionKey Wrapped (encrypted) form of the key represented as a byte array. any

KeyWrapMetadata

Name Description Value
algorithm Algorithm used in wrapping and unwrapping of the data encryption key. string
name The name of associated KeyEncryptionKey (aka CustomerManagedKey). string
type ProviderName of KeyStoreProvider. string
value Reference / link to the KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Description Value
apiVersion The api version '2024-05-15'
name The resource name string (required)
properties Properties to create and update ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (required)
type The resource type 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Terraform (AzAPI provider) resource definition

The databaseAccounts/sqlDatabases/clientEncryptionKeys resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys resource, add the following Terraform to your template.

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

Property values

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Name Description Value
resource The standard JSON format of a ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (required)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Name Description Value
encryptionAlgorithm Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data. string
id Name of the ClientEncryptionKey string
keyWrapMetadata Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key. KeyWrapMetadata
wrappedDataEncryptionKey Wrapped (encrypted) form of the key represented as a byte array. any

KeyWrapMetadata

Name Description Value
algorithm Algorithm used in wrapping and unwrapping of the data encryption key. string
name The name of associated KeyEncryptionKey (aka CustomerManagedKey). string
type ProviderName of KeyStoreProvider. string
value Reference / link to the KeyEncryptionKey. string

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/sqlDatabases
properties Properties to create and update ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (required)
type The resource type "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2024-05-15"