Partager via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2023-11-15-preview

  • 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 de ressource

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

Mise à l’échelle automatique

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

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement du 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)
chemin Chemin d’accès qui doit être chiffré. chaîne (obligatoire)

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 stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement d’ID et de clé de partition. Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2 (obligatoire)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil 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 Liste des chemins d’accès à l’aide desquels les données du conteneur 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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

Index

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

IndexingPolicy

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

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

MaterializedViewDefinition

Nom Description Valeur
définition La définition doit être une requête SQL qui serait utilisée pour extraire des données à partir du conteneur source pour remplir le conteneur Materialized View. chaîne (obligatoire)
sourceCollectionId Nom du conteneur source sur lequel la vue matérialisée sera créée. chaîne (obligatoire)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
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 un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ResourceRestoreParameters

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

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
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'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ressource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResource (obligatoire)

SqlContainerResourceOrSqlContainerGetPropertiesResource

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ération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
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 d’accès au document dans le conteneur IndexingPolicy
materializedViewDefinition Configuration de la définition des vues matérialisées. Cela ne doit être spécifié que pour la création d’un conteneur De vue matérialisée. MaterializedViewDefinition
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

Étiquettes

Nom Description Valeur

UniqueKey

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

UniqueKeyPolicy

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

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep Description
API SQL du compte Azure Cosmos DB avec de magasin analytique 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 le magasin analytique.
Créer un compte Azure Cosmos DB de niveau gratuit 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 partagé et un conteneur.
Créer un compte Azure Cosmos DB pour l’API Core (SQL) 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.
Créer une API SQL de compte Azure Cosmos DB avec mise à l’échelle automatique 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 d’API Azure Cosmos DB Core (SQL) 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.
crée une application de microservices Dapr à l’aide de Container Apps Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB Déployez Azure Data Explorer DB avec la connexion Cosmos DB.

Définition de ressource 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 de ressource

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": "2023-11-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

Mise à l’échelle automatique

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

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement du 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)
chemin Chemin d’accès qui doit être chiffré. chaîne (obligatoire)

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 stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement d’ID et de clé de partition. Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2 (obligatoire)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil 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 Liste des chemins d’accès à l’aide desquels les données du conteneur 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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

Index

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

IndexingPolicy

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

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

MaterializedViewDefinition

Nom Description Valeur
définition La définition doit être une requête SQL qui serait utilisée pour extraire des données à partir du conteneur source pour remplir le conteneur Materialized View. chaîne (obligatoire)
sourceCollectionId Nom du conteneur source sur lequel la vue matérialisée sera créée. chaîne (obligatoire)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nom Description Valeur
apiVersion Version de l’API '2023-11-15-preview'
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'

ResourceRestoreParameters

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

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
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'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ressource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResource (obligatoire)

SqlContainerResourceOrSqlContainerGetPropertiesResource

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ération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
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 d’accès au document dans le conteneur IndexingPolicy
materializedViewDefinition Configuration de la définition des vues matérialisées. Cela ne doit être spécifié que pour la création d’un conteneur De vue matérialisée. MaterializedViewDefinition
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

Étiquettes

Nom Description Valeur

UniqueKey

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

UniqueKeyPolicy

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

Modèles de démarrage rapide

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

Modèle Description
API SQL du compte Azure Cosmos DB avec de 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 le magasin analytique.
Créer 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 partagé et un conteneur.
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.
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 d’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.
crée une application de microservices Dapr à l’aide de Container Apps

Déployer sur Azure 		Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application Dapr pub-sub servicebus à l’aide de Container Apps

Déployer sur Azure 		Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer DB avec de connexion Cosmos DB

Déployer sur Azure 		Déployez Azure Data Explorer DB avec la 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 de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, ajoutez terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valeurs de propriété

Mise à l’échelle automatique

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

ClientEncryptionIncludedPath

Nom Description Valeur
clientEncryptionKeyId Identificateur de la clé de chiffrement du 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)
chemin Chemin d’accès qui doit être chiffré. chaîne (obligatoire)

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 stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement d’ID et de clé de partition. Int

Contraintes:
Valeur minimale = 1
Valeur maximale = 2 (obligatoire)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nom Description Valeur

CompositePath

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

ComputedProperty

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

ConflictResolutionPolicy

Nom Description Valeur
conflictResolutionPath Chemin de résolution de conflit dans le cas du mode LastWriterWins. corde
conflictResolutionProcedure Procédure de résolution des conflits en cas de mode personnalisé. corde
mode Indique le mode de résolution de conflit. 'Custom'
'LastWriterWins'

ContainerPartitionKey

Nom Description Valeur
gentil 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 Liste des chemins d’accès à l’aide desquels les données du conteneur 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

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

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

ExcludedPath

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

IncludedPath

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

Index

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

IndexingPolicy

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

ManagedServiceIdentity

Nom Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nom Description Valeur

MaterializedViewDefinition

Nom Description Valeur
définition La définition doit être une requête SQL qui serait utilisée pour extraire des données à partir du conteneur source pour remplir le conteneur Materialized View. chaîne (obligatoire)
sourceCollectionId Nom du conteneur source sur lequel la vue matérialisée sera créée. chaîne (obligatoire)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nom Description Valeur
identité Identité de la ressource. ManagedServiceIdentity
emplacement Emplacement du groupe de ressources auquel appartient la ressource. corde
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 un conteneur Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obligatoire)
étiquettes Balises de ressource Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15-preview »

ResourceRestoreParameters

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

SpatialSpec

Nom Description Valeur
chemin Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*) corde
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'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
ressource Format JSON standard d’un conteneur SqlContainerResourceOrSqlContainerGetPropertiesResource (obligatoire)

SqlContainerResourceOrSqlContainerGetPropertiesResource

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ération pour indiquer le mode de création de ressources. 'Default'
'PointInTimeRestore'
'Restore'
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 d’accès au document dans le conteneur IndexingPolicy
materializedViewDefinition Configuration de la définition des vues matérialisées. Cela ne doit être spécifié que pour la création d’un conteneur De vue matérialisée. MaterializedViewDefinition
partitionKey Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions ContainerPartitionKey
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters
uniqueKeyPolicy Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB. UniqueKeyPolicy

Étiquettes

Nom Description Valeur

UniqueKey

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

UniqueKeyPolicy

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