Base de données Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-11-15
- La plus récente
- 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
- Préversion du 01/03/2023
- 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
Définition de ressource Bicep
Le type de ressource databaseAccounts/sqlDatabases/clientEncryptionKeys peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, ajoutez le Bicep suivant à votre modèle.
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()
}
}
}
Valeurs de propriétés
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
string (obligatoire) |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : sqlDatabases |
| properties | Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obligatoire) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nom | Description | Valeur |
|---|---|---|
| resource | Format JSON standard d’un ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatoire) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nom | Description | Valeur |
|---|---|---|
| encryptionAlgorithm | Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. | string |
| id | Nom de clientEncryptionKey | string |
| keyWrapMetadata | Métadonnées pour le fournisseur d’habillage qui peuvent être utilisées pour désencapsuler la clé de chiffrement client encapsulée. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forme encapsulée (chiffrée) de la clé représentée sous la forme d’un tableau d’octets. | Pour Bicep, vous pouvez utiliser la fonction any(). |
KeyWrapMetadata
| Nom | Description | Valeur |
|---|---|---|
| algorithme | Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement des données. | string |
| name | Nom de KeyEncryptionKey associé (également appelé CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Référence/lien vers keyEncryptionKey. | string |
Définition de ressources de modèle ARM
Le type de ressource databaseAccounts/sqlDatabases/clientEncryptionKeys peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, ajoutez le code JSON suivant à votre modèle.
{
"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": {}
}
}
}
Valeurs de propriétés
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys' |
| apiVersion | Version de l’API de ressource | '2023-11-15' |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
string (obligatoire) |
| properties | Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obligatoire) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nom | Description | Valeur |
|---|---|---|
| resource | Format JSON standard d’un ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatoire) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nom | Description | Valeur |
|---|---|---|
| encryptionAlgorithm | Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. | string |
| id | Nom de clientEncryptionKey | string |
| keyWrapMetadata | Métadonnées pour le fournisseur d’habillage qui peuvent être utilisées pour désencapsuler la clé de chiffrement client encapsulée. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forme encapsulée (chiffrée) de la clé représentée sous la forme d’un tableau d’octets. |
KeyWrapMetadata
| Nom | Description | Valeur |
|---|---|---|
| algorithme | Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement des données. | string |
| name | Nom de KeyEncryptionKey associé (également appelé CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Référence/lien vers keyEncryptionKey. | string |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource databaseAccounts/sqlDatabases/clientEncryptionKeys peut être déployé avec des opérations qui ciblent :
- Groupes de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, ajoutez le Terraform suivant à votre modèle.
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"
}
}
}
})
}
Valeurs de propriétés
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-11-15 » |
| name | Nom de la ressource | string (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID pour la ressource de type : sqlDatabases |
| properties | Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obligatoire) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nom | Description | Valeur |
|---|---|---|
| resource | Format JSON standard d’un ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obligatoire) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nom | Description | Valeur |
|---|---|---|
| encryptionAlgorithm | Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. | string |
| id | Nom de clientEncryptionKey | string |
| keyWrapMetadata | Métadonnées pour le fournisseur d’habillage qui peuvent être utilisées pour désencapsuler la clé de chiffrement client encapsulée. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forme encapsulée (chiffrée) de la clé représentée sous la forme d’un tableau d’octets. |
KeyWrapMetadata
| Nom | Description | Valeur |
|---|---|---|
| algorithme | Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement des données. | string |
| name | Nom de KeyEncryptionKey associé (également appelé CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Référence/lien vers keyEncryptionKey. | string |