Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-11-06
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 - Consultez 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 de ressource
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-11-06' = {
parent: resourceSymbolicName
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é
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 | 'Hash' 'Range' |
Chemins | Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés | string[] |
CreateUpdateOptions
Nom | Description | Valeur |
---|
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 |
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' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | chaîne (obligatoire) |
parent | Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente. |
Nom symbolique de la ressource de type : databaseAccounts/apis/databases |
Propriétés | Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obligatoire) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
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. | CreateUpdateOptions (obligatoire) |
ressource | Format JSON standard d’un conteneur | sqlContainerResource (obligatoire) |
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 | 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 |
partitionKey | Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions | ContainerPartitionKey |
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 |
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[] |
Définition de ressource 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 - Consultez 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 de ressource
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-11-06",
"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é
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 | 'Hash' 'Range' |
Chemins | Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés | string[] |
CreateUpdateOptions
Nom | Description | Valeur |
---|
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 |
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' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Nom | Description | Valeur |
---|---|---|
apiVersion | Version de l’API | '2015-11-06' |
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. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obligatoire) |
type | Type de ressource | 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers' |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
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. | CreateUpdateOptions (obligatoire) |
ressource | Format JSON standard d’un conteneur | sqlContainerResource (obligatoire) |
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 | 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 |
partitionKey | Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions | ContainerPartitionKey |
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 |
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 |
---|---|
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 de l’API, consultez journal des modifications.
Format de ressource
Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, ajoutez la terraform suivante à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06"
name = "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é
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 | 'Hash' 'Range' |
Chemins | Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés | string[] |
CreateUpdateOptions
Nom | Description | Valeur |
---|
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 |
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' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Nom | Description | Valeur |
---|---|---|
nom | Nom de la ressource | chaîne (obligatoire) |
parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : databaseAccounts/apis/databases |
Propriétés | Propriétés permettant de créer et de mettre à jour un conteneur Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (obligatoire) |
type | Type de ressource | « Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06 » |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
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. | CreateUpdateOptions (obligatoire) |
ressource | Format JSON standard d’un conteneur | sqlContainerResource (obligatoire) |
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 | 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 |
partitionKey | Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions | ContainerPartitionKey |
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 |
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[] |