Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2022-05-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/sqlDatabases/clientEncryptionKeys peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nom Description Valeur
ressource Format JSON standard d’un ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatoire)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nom Description Valeur
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. corde
id Nom de ClientEncryptionKey corde
keyWrapMetadata Métadonnées pour le fournisseur de création de package de restrictions qui peuvent être utilisées pour décompresser la clé de chiffrement du client encapsulée. KeyWrapMetadata
wrappedDataEncryptionKey Forme encapsulée (chiffrée) de la clé représentée sous forme de tableau d’octets. quelconque

KeyWrapMetadata

Nom Description Valeur
algorithme Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement de données. corde
nom Nom de KeyEncryptionKey associé (aka CustomerManagedKey). corde
type ProviderName of KeyStoreProvider. corde
valeur Référence / lien vers KeyEncryptionKey. corde

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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 : databaseAccounts/sqlDatabases
Propriétés Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatoire)

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/sqlDatabases/clientEncryptionKeys peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

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": "2022-05-15-preview",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "algorithm": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      },
      "wrappedDataEncryptionKey": {}
    }
  }
}

Valeurs de propriété

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nom Description Valeur
ressource Format JSON standard d’un ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatoire)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nom Description Valeur
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. corde
id Nom de ClientEncryptionKey corde
keyWrapMetadata Métadonnées pour le fournisseur de création de package de restrictions qui peuvent être utilisées pour décompresser la clé de chiffrement du client encapsulée. KeyWrapMetadata
wrappedDataEncryptionKey Forme encapsulée (chiffrée) de la clé représentée sous forme de tableau d’octets. quelconque

KeyWrapMetadata

Nom Description Valeur
algorithme Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement de données. corde
nom Nom de KeyEncryptionKey associé (aka CustomerManagedKey). corde
type ProviderName of KeyStoreProvider. corde
valeur Référence / lien vers KeyEncryptionKey. corde

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nom Description Valeur
apiVersion Version de l’API '2022-05-15-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatoire)
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys'

Exemples d’utilisation

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 de l’API, consultez journal des modifications.

Format de ressource

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@2022-05-15-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          algorithm = "string"
          name = "string"
          type = "string"
          value = "string"
        }
        wrappedDataEncryptionKey = ?
      }
    }
  }
}

Valeurs de propriété

ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties

Nom Description Valeur
ressource Format JSON standard d’un ClientEncryptionKey ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource (obligatoire)

ClientEncryptionKeyResourceOrClientEncryptionKeyGetPropertiesResource

Nom Description Valeur
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé avec cette clé de chiffrement client pour chiffrer/déchiffrer les données. corde
id Nom de ClientEncryptionKey corde
keyWrapMetadata Métadonnées pour le fournisseur de création de package de restrictions qui peuvent être utilisées pour décompresser la clé de chiffrement du client encapsulée. KeyWrapMetadata
wrappedDataEncryptionKey Forme encapsulée (chiffrée) de la clé représentée sous forme de tableau d’octets. quelconque

KeyWrapMetadata

Nom Description Valeur
algorithme Algorithme utilisé dans l’habillage et le désencapsulation de la clé de chiffrement de données. corde
nom Nom de KeyEncryptionKey associé (aka CustomerManagedKey). corde
type ProviderName of KeyStoreProvider. corde
valeur Référence / lien vers KeyEncryptionKey. corde

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/sqlDatabases
Propriétés Propriétés permettant de créer et de mettre à jour ClientEncryptionKey. ClientEncryptionKeyCreateUpdatePropertiesOrClientEncryptionKeyGetProperties (obligatoire)
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2022-05-15-preview »