Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers
- senaste
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-resursdefinition
Resurstypen databaseAccounts/sqlDatabases/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/sqlDatabases/containers-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-12-01-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'
]
}
]
vectorIndexes: [
{
path: 'string'
type: 'string'
}
]
}
materializedViewDefinition: {
definition: 'string'
sourceCollectionId: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
vectorEmbeddingPolicy: {
vectorEmbeddings: [
{
dataType: 'string'
dimensions: int
distanceFunction: 'string'
path: 'string'
}
]
}
}
}
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
AutoskalningInställningar
| Namn | Beskrivning | Värde |
|---|---|---|
| maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int |
ClientEncryptionIncludedPath
| Namn | Beskrivning | Värde |
|---|---|---|
| clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
| encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
| encryptionType | Vilken typ av kryptering som ska utföras. T.ex. deterministisk, randomiserad. | sträng (krävs) |
| stig | Sökväg som måste krypteras. | sträng (krävs) |
ClientEncryptionPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
| policyFormatVersion | Version av definitionen av klientkrypteringsprincipen. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering. | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 (krävs) |
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde |
|---|
CompositePath
| Namn | Beskrivning | Värde |
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
| 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 |
ComputedProperty
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på en beräknad egenskap, till exempel " cp_lowerName" | sträng |
| fråga | Frågan som utvärderar värdet för den beräknade egenskapen, till exempel " SELECT VALUE LOWER(c.name) FROM c" | sträng |
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. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde |
|---|---|---|
| autoscaleSettings | Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. | AutoscaleSettings |
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int |
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 |
| compositeIndexes | Lista över lista över sammansatta sökvägar | CompositePath[][] |
| 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" |
| spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
| vectorIndexes | Lista över sökvägar som ska inkluderas i vektorindexeringen | VectorIndex[] |
ManagedServiceIdentity
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter |
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|
MaterializedViewDefinition
| Namn | Beskrivning | Värde |
|---|---|---|
| definition | Definitionen bör vara en SQL-fråga som skulle användas för att hämta data från källcontainern för att fylla i containern Materialized View. | sträng (krävs) |
| sourceCollectionId | Namnet på källcontainern där den materialiserade vyn ska skapas. | sträng (krävs) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde |
|---|---|---|
| identitet | Identitet för resursen. | ManagedServiceIdentity |
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng |
| 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/sqlDatabases |
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
ResourceRestoreParameters
| Namn | Beskrivning | Värde |
|---|---|---|
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid då kontot måste återställas (ISO-8601-format). | sträng |
| restoreWithTtlDisabled | Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. | Bool |
SpatialSpec
| 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 |
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 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. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde |
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int |
| clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
| computedProperties | Lista över beräknade egenskaper | ComputedProperty[] |
| conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
| createMode | Uppräkning för att ange läget för att skapa resurser. | "Standard" "Återställ" |
| 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 |
| materializedViewDefinition | Konfigurationen för att definiera materialiserade vyer. Detta måste endast anges för att skapa en materialiserad vycontainer. | MaterializedViewDefinition |
| partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
| restoreParameters | Parametrar som anger information om återställningen | ResourceRestoreParameters |
| uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
| vectorEmbeddingPolicy | Vektorinbäddningsprincipen för containern. | VectorEmbeddingPolicy |
Taggar
| Namn | Beskrivning | Värde |
|---|
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[] |
VectorEmbedding
| Namn | Beskrivning | Värde |
|---|---|---|
| Datatyp | Anger datatypen för vektor. | "float32" "int8" "uint8" (krävs) |
| mått | Antalet dimensioner i vektorn. | int (krävs) |
| distanceFunction | Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer. | "cosiné" "dotproduct" "euclidean" (krävs) |
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
VectorEmbeddingPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| vectorEmbeddings | Lista över vektorbäddningar | VectorEmbedding[] |
VectorIndex
| Namn | Beskrivning | Värde |
|---|---|---|
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
| typ | Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat. | "diskANN" "platt" "quantizedFlat" (krävs) |
Snabbstartsexempel
Följande snabbstartsexempel distribuerar den här resurstypen.
| Bicep-fil | Beskrivning |
|---|---|
| SQL API för Azure Cosmos DB-konto med analysarkiv | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet. |
| Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå | Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container. |
| Skapa ett Azure Cosmos DB-konto för Core (SQL) API | Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ. |
| Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ. |
| Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL) | Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion. |
| Skapar en Dapr-mikrotjänstapp med containerappar | Skapa en Dapr-mikrotjänstapp med containerappar. |
| Skapar en Dapr pub-sub servicebus-app med containerappar | Skapa en Dapr pub-sub servicebus-app med containerappar. |
| Distribuera Azure Data Explorer DB med Cosmos DB-anslutning | Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/sqlDatabases/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/sqlDatabases/containers-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2024-12-01-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" ]
}
],
"vectorIndexes": [
{
"path": "string",
"type": "string"
}
]
},
"materializedViewDefinition": {
"definition": "string",
"sourceCollectionId": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
},
"vectorEmbeddingPolicy": {
"vectorEmbeddings": [
{
"dataType": "string",
"dimensions": "int",
"distanceFunction": "string",
"path": "string"
}
]
}
}
},
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
AutoskalningInställningar
| Namn | Beskrivning | Värde |
|---|---|---|
| maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int |
ClientEncryptionIncludedPath
| Namn | Beskrivning | Värde |
|---|---|---|
| clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
| encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
| encryptionType | Vilken typ av kryptering som ska utföras. T.ex. deterministisk, randomiserad. | sträng (krävs) |
| stig | Sökväg som måste krypteras. | sträng (krävs) |
ClientEncryptionPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
| policyFormatVersion | Version av definitionen av klientkrypteringsprincipen. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering. | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 (krävs) |
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde |
|---|
CompositePath
| Namn | Beskrivning | Värde |
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
| 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 |
ComputedProperty
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på en beräknad egenskap, till exempel " cp_lowerName" | sträng |
| fråga | Frågan som utvärderar värdet för den beräknade egenskapen, till exempel " SELECT VALUE LOWER(c.name) FROM c" | sträng |
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. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde |
|---|---|---|
| autoscaleSettings | Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. | AutoscaleSettings |
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int |
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 |
| compositeIndexes | Lista över lista över sammansatta sökvägar | CompositePath[][] |
| 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" |
| spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
| vectorIndexes | Lista över sökvägar som ska inkluderas i vektorindexeringen | VectorIndex[] |
ManagedServiceIdentity
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter |
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|
MaterializedViewDefinition
| Namn | Beskrivning | Värde |
|---|---|---|
| definition | Definitionen bör vara en SQL-fråga som skulle användas för att hämta data från källcontainern för att fylla i containern Materialized View. | sträng (krävs) |
| sourceCollectionId | Namnet på källcontainern där den materialiserade vyn ska skapas. | sträng (krävs) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | "2024-12-01-preview" |
| identitet | Identitet för resursen. | ManagedServiceIdentity |
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng |
| Namn | Resursnamnet | sträng (krävs) |
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" |
ResourceRestoreParameters
| Namn | Beskrivning | Värde |
|---|---|---|
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid då kontot måste återställas (ISO-8601-format). | sträng |
| restoreWithTtlDisabled | Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. | Bool |
SpatialSpec
| 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 |
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 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. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde |
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int |
| clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
| computedProperties | Lista över beräknade egenskaper | ComputedProperty[] |
| conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
| createMode | Uppräkning för att ange läget för att skapa resurser. | "Standard" "Återställ" |
| 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 |
| materializedViewDefinition | Konfigurationen för att definiera materialiserade vyer. Detta måste endast anges för att skapa en materialiserad vycontainer. | MaterializedViewDefinition |
| partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
| restoreParameters | Parametrar som anger information om återställningen | ResourceRestoreParameters |
| uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
| vectorEmbeddingPolicy | Vektorinbäddningsprincipen för containern. | VectorEmbeddingPolicy |
Taggar
| Namn | Beskrivning | Värde |
|---|
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[] |
VectorEmbedding
| Namn | Beskrivning | Värde |
|---|---|---|
| Datatyp | Anger datatypen för vektor. | "float32" "int8" "uint8" (krävs) |
| mått | Antalet dimensioner i vektorn. | int (krävs) |
| distanceFunction | Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer. | "cosiné" "dotproduct" "euclidean" (krävs) |
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
VectorEmbeddingPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| vectorEmbeddings | Lista över vektorbäddningar | VectorEmbedding[] |
VectorIndex
| Namn | Beskrivning | Värde |
|---|---|---|
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
| typ | Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat. | "diskANN" "platt" "quantizedFlat" (krävs) |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
SQL API för Azure Cosmos DB-konto med analysarkiv
|
Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet. |
|
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå
|
Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container. |
|
Skapa ett Azure Cosmos DB-konto för Core (SQL) API
|
Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ. |
|
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning
|
Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ. |
|
Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL)
|
Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion. |
|
Skapar en Dapr-mikrotjänstapp med containerappar
|
Skapa en Dapr-mikrotjänstapp med containerappar. |
|
Skapar en Dapr pub-sub servicebus-app med containerappar
|
Skapa en Dapr pub-sub servicebus-app med containerappar. |
|
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning
|
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/sqlDatabases/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 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-12-01-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"
]
}
]
vectorIndexes = [
{
path = "string"
type = "string"
}
]
}
materializedViewDefinition = {
definition = "string"
sourceCollectionId = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
vectorEmbeddingPolicy = {
vectorEmbeddings = [
{
dataType = "string"
dimensions = int
distanceFunction = "string"
path = "string"
}
]
}
}
}
})
}
Egenskapsvärden
AutoskalningInställningar
| Namn | Beskrivning | Värde |
|---|---|---|
| maxThroughput | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int |
ClientEncryptionIncludedPath
| Namn | Beskrivning | Värde |
|---|---|---|
| clientEncryptionKeyId | Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. | sträng (krävs) |
| encryptionAlgorithm | Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. | sträng (krävs) |
| encryptionType | Vilken typ av kryptering som ska utföras. T.ex. deterministisk, randomiserad. | sträng (krävs) |
| stig | Sökväg som måste krypteras. | sträng (krävs) |
ClientEncryptionPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| includedPaths | Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. | ClientEncryptionIncludedPath[] (krävs) |
| policyFormatVersion | Version av definitionen av klientkrypteringsprincipen. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering. | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 (krävs) |
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde |
|---|
CompositePath
| Namn | Beskrivning | Värde |
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" |
| 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 |
ComputedProperty
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Namnet på en beräknad egenskap, till exempel " cp_lowerName" | sträng |
| fråga | Frågan som utvärderar värdet för den beräknade egenskapen, till exempel " SELECT VALUE LOWER(c.name) FROM c" | sträng |
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. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" |
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | string[] |
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde |
|---|---|---|
| autoscaleSettings | Anger inställningarna för autoskalning. Obs! Antingen dataflöde eller autoskalningInställningar krävs, men inte båda. | AutoscaleSettings |
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int |
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 |
| compositeIndexes | Lista över lista över sammansatta sökvägar | CompositePath[][] |
| 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" |
| spatialIndexes | Lista över rumsliga detaljer | SpatialSpec[] |
| vectorIndexes | Lista över sökvägar som ska inkluderas i vektorindexeringen | VectorIndex[] |
ManagedServiceIdentity
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| userAssignedIdentities | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter |
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde |
|---|
MaterializedViewDefinition
| Namn | Beskrivning | Värde |
|---|---|---|
| definition | Definitionen bör vara en SQL-fråga som skulle användas för att hämta data från källcontainern för att fylla i containern Materialized View. | sträng (krävs) |
| sourceCollectionId | Namnet på källcontainern där den materialiserade vyn ska skapas. | sträng (krävs) |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde |
|---|---|---|
| identitet | Identitet för resursen. | ManagedServiceIdentity |
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng |
| 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/sqlDatabases |
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) |
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-12-01-preview" |
ResourceRestoreParameters
| Namn | Beskrivning | Värde |
|---|---|---|
| restoreSource | ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | sträng |
| restoreTimestampInUtc | Tid då kontot måste återställas (ISO-8601-format). | sträng |
| restoreWithTtlDisabled | Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. | Bool |
SpatialSpec
| 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 |
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 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. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde |
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int |
| clientEncryptionPolicy | Klientkrypteringsprincipen för containern. | ClientEncryptionPolicy |
| computedProperties | Lista över beräknade egenskaper | ComputedProperty[] |
| conflictResolutionPolicy | Konfliktlösningsprincipen för containern. | ConflictResolutionPolicy |
| createMode | Uppräkning för att ange läget för att skapa resurser. | "Standard" "Återställ" |
| 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 |
| materializedViewDefinition | Konfigurationen för att definiera materialiserade vyer. Detta måste endast anges för att skapa en materialiserad vycontainer. | MaterializedViewDefinition |
| partitionKey | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey |
| restoreParameters | Parametrar som anger information om återställningen | ResourceRestoreParameters |
| uniqueKeyPolicy | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy |
| vectorEmbeddingPolicy | Vektorinbäddningsprincipen för containern. | VectorEmbeddingPolicy |
Taggar
| Namn | Beskrivning | Värde |
|---|
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[] |
VectorEmbedding
| Namn | Beskrivning | Värde |
|---|---|---|
| Datatyp | Anger datatypen för vektor. | "float32" "int8" "uint8" (krävs) |
| mått | Antalet dimensioner i vektorn. | int (krävs) |
| distanceFunction | Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer. | "cosiné" "dotproduct" "euclidean" (krävs) |
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
VectorEmbeddingPolicy
| Namn | Beskrivning | Värde |
|---|---|---|
| vectorEmbeddings | Lista över vektorbäddningar | VectorEmbedding[] |
VectorIndex
| Namn | Beskrivning | Värde |
|---|---|---|
| stig | Sökvägen till vektorfältet i dokumentet. | sträng (krävs) |
| typ | Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat. | "diskANN" "platt" "quantizedFlat" (krävs) |