Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-11-06
Bicep-resursdefinition
Resurstypen databaseAccounts/apis/databases/containers kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/apis/databases/containers-resurs lägger du till följande Bicep i mallen.
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'
]
}
]
}
}
}
}
Egenskapsvärden
ConflictResolutionPolicy
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng |
läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
ContainerPartitionKey
Namn | Beskrivning | Värde |
---|---|---|
sort | Anger vilken typ av algoritm som används för partitionering | "Hash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
CreateUpdateOptions
Namn | Beskrivning | Värde |
---|
ExcludedPath
Namn | Beskrivning | Värde |
---|---|---|
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
IncludedPath
Namn | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
Index
Namn | Beskrivning | Värde |
---|---|---|
Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Indexets precision. -1 är maximal precision. | Int |
IndexingPolicy
Namn | Beskrivning | Värde |
---|---|---|
automatisk | Anger om indexeringsprincipen är automatisk | Bool |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "Konsekvent" "Lat" "Ingen" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Namn | Beskrivning | Värde |
---|---|---|
Namn | Resursnamnet | sträng (krävs) |
förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: databaseAccounts/apis/databases |
Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (krävs) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Namn | Beskrivning | Värde |
---|---|---|
Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptions (krävs) |
resurs | JSON-standardformatet för en container | SqlContainerResource (krävs) |
SqlContainerResource
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid till live | Int |
Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
UniqueKey
Namn | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |
UniqueKeyPolicy
Namn | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/apis/databases/containers kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/apis/databases/containers-resurs lägger du till följande JSON i mallen.
{
"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" ]
}
]
}
}
}
}
Egenskapsvärden
ConflictResolutionPolicy
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng |
läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
ContainerPartitionKey
Namn | Beskrivning | Värde |
---|---|---|
sort | Anger vilken typ av algoritm som används för partitionering | "Hash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
CreateUpdateOptions
Namn | Beskrivning | Värde |
---|
ExcludedPath
Namn | Beskrivning | Värde |
---|---|---|
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
IncludedPath
Namn | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
Index
Namn | Beskrivning | Värde |
---|---|---|
Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Indexets precision. -1 är maximal precision. | Int |
IndexingPolicy
Namn | Beskrivning | Värde |
---|---|---|
automatisk | Anger om indexeringsprincipen är automatisk | Bool |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "Konsekvent" "Lat" "Ingen" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Namn | Beskrivning | Värde |
---|---|---|
apiVersion | API-versionen | '2015-11-06' |
Namn | Resursnamnet | sträng (krävs) |
Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (krävs) |
typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Namn | Beskrivning | Värde |
---|---|---|
Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptions (krävs) |
resurs | JSON-standardformatet för en container | SqlContainerResource (krävs) |
SqlContainerResource
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid till live | Int |
Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
UniqueKey
Namn | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |
UniqueKeyPolicy
Namn | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Beskrivning |
---|---|
Skapa Azure Cosmos med SQL API och flera containrar |
Mallen skapar en Cosmos-container med ett SQL API och gör det möjligt att lägga till flertrådscontainrar. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/apis/databases/containers kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/containers lägger du till följande Terraform i mallen.
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"
]
}
]
}
}
}
})
}
Egenskapsvärden
ConflictResolutionPolicy
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng |
conflictResolutionProcedure | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng |
läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" |
ContainerPartitionKey
Namn | Beskrivning | Värde |
---|---|---|
sort | Anger vilken typ av algoritm som används för partitionering | "Hash" "Intervall" |
Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
CreateUpdateOptions
Namn | Beskrivning | Värde |
---|
ExcludedPath
Namn | Beskrivning | Värde |
---|---|---|
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
IncludedPath
Namn | Beskrivning | Värde |
---|---|---|
Index | Lista över index för den här sökvägen | Index[] |
stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng |
Index
Namn | Beskrivning | Värde |
---|---|---|
Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" |
sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" |
precision | Indexets precision. -1 är maximal precision. | Int |
IndexingPolicy
Namn | Beskrivning | Värde |
---|---|---|
automatisk | Anger om indexeringsprincipen är automatisk | Bool |
excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] |
includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] |
indexingMode | Anger indexeringsläget. | "Konsekvent" "Lat" "Ingen" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
Namn | Beskrivning | Värde |
---|---|---|
Namn | Resursnamnet | sträng (krävs) |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: databaseAccounts/apis/databases |
Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (krävs) |
typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06" |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Namn | Beskrivning | Värde |
---|---|---|
Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptions (krävs) |
resurs | JSON-standardformatet för en container | SqlContainerResource (krävs) |
SqlContainerResource
Namn | Beskrivning | Värde |
---|---|---|
conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
defaultTtl | Standardtid till live | Int |
Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) |
indexingPolicy | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | IndexingPolicy |
partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
UniqueKey
Namn | Beskrivning | Värde |
---|---|---|
Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | string[] |
UniqueKeyPolicy
Namn | Beskrivning | Värde |
---|---|---|
uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] |