Base de données Microsoft.DocumentDBAccounts/apis/databases/containers 2015-04-01
Définition de ressource Bicep
Le type de ressource databaseAccounts/apis/databases/containers 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/apis/databases/containers, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
options: {
{customized property}: 'string'
}
resource: {
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
Valeurs de propriétés
databaseAccounts/apis/databases/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. |
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 : bases de données |
| properties | Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obligatoire) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptions (obligatoire) |
| resource | Format JSON standard d’un conteneur | SqlContainerResource (obligatoire) |
CreateUpdateOptions
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | string |
SqlContainerResource
| Nom | Description | Valeur |
|---|---|---|
| conflictResolutionPolicy | Stratégie de résolution des conflits pour le conteneur. | ConflictResolutionPolicy |
| 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 |
| 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 |
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 |
| 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' |
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 |
ContainerPartitionKey
| Nom | Description | Valeur |
|---|---|---|
| kind | Indique le type d’algorithme utilisé pour le partitionnement | 'Hachage' 'Range' |
| chemins d'accès | Liste des chemins d’accès à l’aide des données du conteneur qui peuvent être partitionnés | 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éer Azure Cosmos avec l’API SQL et plusieurs conteneurs
|
Le modèle crée un conteneur Cosmos avec une API SQL et permet d’ajouter des conteneurs mulitple. |
Définition de ressources de modèle ARM
Le type de ressource databaseAccounts/apis/databases/containers peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de 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/apis/databases/containers, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
"apiVersion": "2015-04-01",
"name": "string",
"properties": {
"options": {
"{customized property}": "string"
},
"resource": {
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ]
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
Valeurs de propriétés
databaseAccounts/apis/databases/containers
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/apis/databases/containers » |
| apiVersion | Version de l’API de ressource | '2015-04-01' |
| 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 un conteneur Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obligatoire) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptions (obligatoire) |
| resource | Format JSON standard d’un conteneur | SqlContainerResource (obligatoire) |
CreateUpdateOptions
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | string |
SqlContainerResource
| Nom | Description | Valeur |
|---|---|---|
| conflictResolutionPolicy | Stratégie de résolution des conflits pour le conteneur. | ConflictResolutionPolicy |
| 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 |
| 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 |
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 |
| 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' |
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 |
ContainerPartitionKey
| Nom | Description | Valeur |
|---|---|---|
| kind | Indique le type d’algorithme utilisé pour le partitionnement | 'Hash' 'Range' |
| chemins d'accès | Liste des chemins d’accès utilisant les données du conteneur qui peuvent être partitionnés | 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 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éer Azure Cosmos avec l’API SQL et plusieurs conteneurs
|
Le modèle crée un conteneur Cosmos avec une API SQL et permet d’ajouter des conteneurs mulitple. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource databaseAccounts/apis/databases/containers 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/apis/databases/containers, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
options = {
{customized property} = "string"
}
resource = {
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
Valeurs de propriétés
databaseAccounts/apis/databases/containers
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01 » |
| 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 : bases de données |
| properties | Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (obligatoire) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProp...
| Nom | Description | Valeur |
|---|---|---|
| options | Paire clé-valeur d’options à appliquer pour la demande. Cela correspond aux en-têtes envoyés avec la demande. | CreateUpdateOptions (obligatoire) |
| resource | Format JSON standard d’un conteneur | SqlContainerResource (obligatoire) |
CreateUpdateOptions
| Nom | Description | Valeur |
|---|---|---|
| {propriété personnalisée} | string |
SqlContainerResource
| Nom | Description | Valeur |
|---|---|---|
| conflictResolutionPolicy | Stratégie de résolution des conflits pour le conteneur. | ConflictResolutionPolicy |
| 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 dans plusieurs partitions | ContainerPartitionKey |
| 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 |
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 |
| 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" |
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 |
ContainerPartitionKey
| Nom | Description | Valeur |
|---|---|---|
| kind | Indique le type d’algorithme utilisé pour le partitionnement | « Hachage » « Plage » |
| chemins d'accès | Liste des chemins d’accès à l’aide des données du conteneur qui peuvent être partitionnés | 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 doit être unique pour chaque document dans le service Azure Cosmos DB | string[] |