Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-11-15
- Latest
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15-preview
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15-preview
Bicep resource definition
The databaseAccounts/sqlDatabases/clientEncryptionKeys resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-11-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
Property values
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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: sqlDatabases |
| properties | Properties to create and update ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (required) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (required) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 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. | For Bicep, you can use the any() function. |
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 |
ARM template resource definition
The databaseAccounts/sqlDatabases/clientEncryptionKeys resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2023-11-15",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
Property values
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys' |
| apiVersion | The resource api version | '2023-11-15' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Properties to create and update ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (required) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (required) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 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. |
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 |
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@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"
}
}
}
})
}
Property values
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15" |
| 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: sqlDatabases |
| properties | Properties to create and update ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (required) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Description | Value |
|---|---|---|
| resource | The standard JSON format of a ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (required) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| 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. |
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 |