Partager via

Base de données Microsoft.DocumentDBAccounts/sqlDatabases/conteneurs

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/sqlDatabases/conteneurs 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/containers, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          {
            order: 'string'
            path: 'string'
          }
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers

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)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
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 un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatoire)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings sont requis, mais pas les deux. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

Paramètres de mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal jusqu’à lequel la ressource peut effectuer un scale-up. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. int
clientEncryptionPolicy Stratégie de chiffrement du client pour le conteneur. ClientEncryptionPolicy
computedProperties Liste des propriétés calculées ComputedProperty[]
conflictResolutionPolicy Stratégie de résolution des conflits pour le conteneur. ConflictResolutionPolicy
createMode Énumérez pour indiquer le mode de création de ressource. 'Par défaut'
'Restore'
defaultTtl Durée de vie par défaut int
id Nom du conteneur SQL Cosmos DB string (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins de document dans le conteneur IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner les données en plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de la stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nom Description Valeur
includedPaths Chemins d’accès de l’élément qui ont besoin d’un chiffrement avec des paramètres spécifiques au chemin d’accès. ClientEncryptionIncludedPath[] (obligatoire)
policyFormatVersion Version de la définition de la stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement des chemins de clé de partition et d’ID. int (obligatoire)

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement client à utiliser pour chiffrer le chemin d’accès. string (obligatoire)
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé. Par exemple - AEAD_AES_256_CBC_HMAC_SHA256. string (obligatoire)
encryptionType Type de chiffrement à effectuer. Par exemple - Déterministe, Aléatoire. string (obligatoire)
path Chemin qui doit être chiffré. string (obligatoire)

ComputedProperty

Nom Description Valeur
name Nom d’une propriété calculée, par exemple , « cp_lowerName » string
query Requête qui évalue la valeur de la propriété calculée, par exemple - « SELECT VALUE LOWER(c.name) FROM c » string

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. 'Personnalisé'
'LastWriterWins'

IndexingPolicy

Nom Description Valeur
automatique Indique si la stratégie d’indexation est automatique bool
compositeIndexes Liste des chemins d’accès composites CompositePath[]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins d’accès à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. 'consistent'
'paresseux'
'none'
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. 'croissant'
'décroissant'
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

IncludedPath

Nom Description Valeur
index Liste des index pour ce chemin d’accès Index[]
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Nombre'
'Point'
'Polygon'
'String'
kind Indique le type d'index. 'Hash'
'Range'
'Spatial'
précision Précision de l’index. -1 correspond à la précision maximale. int

SpatialSpec

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string
types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
'LineString'
'MultiPolygon'
'Point'
'Polygon'

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur 'Hash'
'MultiHash'
'Range'
chemins d'accès Liste des chemins d’accès à l’aide des données du conteneur qui peuvent être partitionnés string[]
version Indique la version de la définition de clé de partition int

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string

UniqueKeyPolicy

Nom Description Valeur
uniqueKeys Liste des clés uniques sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]

UniqueKey

Nom Description Valeur
chemins d'accès La liste des chemins d’accès doit être unique pour chaque document dans le service Azure Cosmos DB string[]

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créez un compte Azure Cosmos DB de niveau gratuit

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit et un conteneur partagés.
Créer un compte Azure Cosmos DB pour l’API Core (SQL)

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit avec plusieurs autres options.
API SQL de compte Azure Cosmos DB avec magasin analytique

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un magasin analytique.
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options.
Créer des procédures stockées de l’API Azure Cosmos DB Core (SQL)

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
Déployer Azure Data Explorer DB avec une connexion Cosmos DB

Déployer sur Azure		 Déployez Azure Data Explorer DB avec une connexion Cosmos DB.

Définition de ressources de modèle ARM

Le type de ressource databaseAccounts/sqlDatabases/conteneurs 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/containers, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          {
            "order": "string",
            "path": "string"
          }
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/conteneurs »
apiVersion Version de l’API de ressource '2024-05-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.		 chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
properties Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatoire)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings sont requis, mais pas les deux. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

Paramètres de mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal auquel la ressource peut effectuer un scale-up. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. int
clientEncryptionPolicy Stratégie de chiffrement du client pour le conteneur. ClientEncryptionPolicy
computedProperties Liste des propriétés calculées ComputedProperty[]
conflictResolutionPolicy Stratégie de résolution des conflits pour le conteneur. ConflictResolutionPolicy
createMode Énumérez pour indiquer le mode de création des ressources. 'Par défaut'
'Restaurer'
defaultTtl Durée de vie par défaut int
id Nom du conteneur SQL Cosmos DB chaîne (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins de document dans le conteneur IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner les données dans plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations sur la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nom Description Valeur
includedPaths Chemins d’accès de l’élément qui nécessitent un chiffrement ainsi que des paramètres spécifiques au chemin d’accès. ClientEncryptionIncludedPath[] (obligatoire)
policyFormatVersion Version de la définition de stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement des chemins d’accès à l’id et à la clé de partition. int (obligatoire)

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement client à utiliser pour chiffrer le chemin d’accès. chaîne (obligatoire)
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé. Par exemple - AEAD_AES_256_CBC_HMAC_SHA256. chaîne (obligatoire)
encryptionType Type de chiffrement à effectuer. Par exemple - Déterministe, Aléatoire. chaîne (obligatoire)
path Chemin qui doit être chiffré. chaîne (obligatoire)

ComputedProperty

Nom Description Valeur
name Nom d’une propriété calculée, par exemple « cp_lowerName » string
query Requête qui évalue la valeur de la propriété calculée, par exemple « SELECT VALUE LOWER(c.name) FROM c » string

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. 'Personnalisé'
'LastWriterWins'

IndexingPolicy

Nom Description Valeur
automatique Indique si la stratégie d’indexation est automatique bool
compositeIndexes Liste de chemins composites CompositePath[]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins d’accès à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. 'cohérent'
'paresseux'
'none'
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. 'croissant'
'décroissant'
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

IncludedPath

Nom Description Valeur
index Liste des index pour ce chemin d’accès Index[]
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Polygon'
'String'
kind Indique le type d'index. 'Hachage'
'Range'
'Spatial'
précision Précision de l’index. -1 est une précision maximale. int

SpatialSpec

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string
types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
'LineString'
'MultiPolygon'
'Point'
'Polygon'

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur 'Hachage'
'MultiHash'
'Range'
chemins d'accès Liste des chemins d’accès à l’aide des données du conteneur qui peuvent être partitionnés string[]
version Indique la version de la définition de clé de partition int

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string

UniqueKeyPolicy

Nom Description Valeur
uniqueKeys Liste des clés uniques sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]

UniqueKey

Nom Description Valeur
chemins d'accès La liste des chemins d’accès doit être unique pour chaque document dans le service Azure Cosmos DB string[]

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créez un compte Azure Cosmos DB de niveau gratuit

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données avec un débit et un conteneur partagés.
Créer un compte Azure Cosmos DB pour l’API Core (SQL)

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit avec plusieurs autres options.
API SQL de compte Azure Cosmos DB avec magasin analytique

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un magasin analytique.
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec un débit de mise à l’échelle automatique avec plusieurs autres options.
Créer des procédures stockées de l’API Azure Cosmos DB Core (SQL)

Déployer sur Azure		 Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) et un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
Déployer Azure Data Explorer DB avec une connexion Cosmos DB

Déployer sur Azure		 Déployez Azure Data Explorer DB avec une connexion Cosmos DB.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/sqlDatabases/conteneurs 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/containers, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            {
              order = "string"
              path = "string"
            }
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valeurs de propriétés

databaseAccounts/sqlDatabases/containers

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15 »
name Nom de la ressource chaîne (obligatoire)
location Emplacement du groupe de ressources auquel appartient la ressource. string
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : sqlDatabases
tags Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent servir à l’affichage et au regroupement des ressources (parmi tous les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit disposer d’une clé de 128 caractères maximum et d’une valeur de 256 caractères maximum. Par exemple, l’expérience par défaut pour un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ». Dictionnaire de noms et de valeurs d’étiquettes.
properties Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatoire)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nom Description Valeur
options Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatoire)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nom Description Valeur
autoscaleSettings Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings sont requis, mais pas les deux. AutoscaleSettings
throughput Unités de requête par seconde. Par exemple, « débit » : 10000. int

Paramètres de mise à l’échelle automatique

Nom Description Valeur
maxThroughput Représente le débit maximal auquel la ressource peut effectuer un scale-up. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nom Description Valeur
analyticalStorageTtl Durée de vie analytique. int
clientEncryptionPolicy Stratégie de chiffrement du client pour le conteneur. ClientEncryptionPolicy
computedProperties Liste des propriétés calculées ComputedProperty[]
conflictResolutionPolicy Stratégie de résolution des conflits pour le conteneur. ConflictResolutionPolicy
createMode Énumérez pour indiquer le mode de création des ressources. « Par défaut »
« Restaurer »
defaultTtl Durée de vie par défaut int
id Nom du conteneur SQL Cosmos DB chaîne (obligatoire)
indexingPolicy Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins de document dans le conteneur IndexingPolicy
partitionKey Configuration de la clé de partition à utiliser pour partitionner les données dans plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations sur la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de stratégie de clé unique permettant de spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nom Description Valeur
includedPaths Chemins d’accès de l’élément qui nécessitent un chiffrement ainsi que des paramètres spécifiques au chemin d’accès. ClientEncryptionIncludedPath[] (obligatoire)
policyFormatVersion Version de la définition de stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement des chemins d’accès à l’id et à la clé de partition. int (obligatoire)

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement client à utiliser pour chiffrer le chemin d’accès. string (obligatoire)
encryptionAlgorithm Algorithme de chiffrement qui sera utilisé. Par exemple - AEAD_AES_256_CBC_HMAC_SHA256. string (obligatoire)
encryptionType Type de chiffrement à effectuer. Par exemple - Déterministe, Aléatoire. string (obligatoire)
path Chemin qui doit être chiffré. string (obligatoire)

ComputedProperty

Nom Description Valeur
name Nom d’une propriété calculée, par exemple , « cp_lowerName » string
query Requête qui évalue la valeur de la propriété calculée, par exemple - « SELECT VALUE LOWER(c.name) FROM c » string

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution des conflits dans le cas du mode LastWriterWins. string
conflictResolutionProcedure Procédure permettant de résoudre les conflits dans le cas du mode personnalisé. string
mode Indique le mode de résolution des conflits. "Custom"
« LastWriterWins »

IndexingPolicy

Nom Description Valeur
automatique Indique si la stratégie d’indexation est automatique bool
compositeIndexes Liste des chemins d’accès composites CompositePath[]
excludedPaths Liste des chemins d’accès à exclure de l’indexation ExcludedPath[]
includedPaths Liste des chemins d’accès à inclure dans l’indexation IncludedPath[]
indexingMode Indique le mode d’indexation. « cohérent »
« paresseux »
« none »
spatialIndexes Liste des spécificités spatiales SpatialSpec[]

CompositePath

Nom Description Valeur
order Ordre de tri pour les chemins composites. « croissant »
« décroissant »
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

ExcludedPath

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

IncludedPath

Nom Description Valeur
index Liste des index pour ce chemin d’accès Index[]
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string

Index

Nom Description Valeur
dataType Type de données auquel le comportement d’indexation est appliqué. « LineString »
« MultiPolygon »
« Nombre »
« Point »
« Polygone »
« String »
kind Indique le type d'index. « Hachage »
« Plage »
« Spatial »
précision Précision de l’index. -1 est une précision maximale. int

SpatialSpec

Nom Description Valeur
path Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et se terminent par un caractère générique (/path/*) string
types Liste du type spatial du chemin d’accès Tableau de chaînes contenant l’un des éléments suivants :
« LineString »
« MultiPolygon »
« Point »
« Polygone »

ContainerPartitionKey

Nom Description Valeur
kind Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur « Hachage »
« Multihash »
« Plage »
chemins d'accès Liste des chemins d’accès à l’aide des données du conteneur qui peuvent être partitionnés string[]
version Indique la version de la définition de clé de partition int

Contraintes :
Valeur minimale = 1
Valeur maximale = 2

ResourceRestoreParameters

Nom Description Valeur
restoreSource ID du compte de base de données restaurable à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string

UniqueKeyPolicy

Nom Description Valeur
uniqueKeys Liste des clés uniques sur qui applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKey[]

UniqueKey

Nom Description Valeur
chemins d'accès La liste des chemins d’accès doit être unique pour chaque document dans le service Azure Cosmos DB string[]