Partager via


Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 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 :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’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@2021-10-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    resource: {
      encryptionAlgorithm: 'string'
      id: 'string'
      keyWrapMetadata: {
        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.
chaîne (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 de wrapping 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
name Nom de KeyEncryptionKey associé (aka CustomerManagedKey). string
type ProviderName de KeyStoreProvider. string
value Référencez/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 :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’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": "2021-10-15-preview",
  "name": "string",
  "properties": {
    "resource": {
      "encryptionAlgorithm": "string",
      "id": "string",
      "keyWrapMetadata": {
        "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 « 2021-10-15-preview »
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.
chaîne (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 de wrapping 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
name Nom de KeyEncryptionKey associé (aka CustomerManagedKey). string
type ProviderName de KeyStoreProvider. string
value Référencez/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 de l’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@2021-10-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      resource = {
        encryptionAlgorithm = "string"
        id = "string"
        keyWrapMetadata = {
          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@2021-10-15-preview »
name Nom de la ressource chaîne (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 de wrapping 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
name Nom de KeyEncryptionKey associé (aka CustomerManagedKey). string
type ProviderName de KeyStoreProvider. string
value Référencez/lien vers keyEncryptionKey. string