Sdílet prostřednictvím


Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

Definice prostředku Bicep

Typ prostředku databaseAccounts/sqlDatabases/containers je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-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'
      dataMaskingPolicy: {
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            length: int
            path: 'string'
            startPosition: int
            strategy: 'string'
          }
        ]
        isPolicyEnabled: bool
      }
      defaultTtl: int
      fullTextPolicy: {
        defaultLanguage: 'string'
        fullTextPaths: [
          {
            language: 'string'
            path: 'string'
          }
        ]
      }
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        fullTextIndexes: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            indexingSearchListSize: int
            path: 'string'
            quantizationByteSize: int
            type: 'string'
            vectorIndexShardKey: [
              'string'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
        throughputBucketForBuild: int
      }
      materializedViews: [
        {
          id: 'string'
          _rid: 'string'
        }
      ]
      materializedViewsProperties: {
        throughputBucketForBuild: int
      }
      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'
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
nadřazený objekt V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: databaseAccounts/sqlDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB sqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Zahrnutá cesta ke šifrování klienta

Jméno Popis Hodnota
ID klíče šifrování klienta Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty. string (povinné)
šifrovacíchAlgoritmů Šifrovací algoritmus, který se použije. Např - AEAD_AES_256_CBC_HMAC_SHA256. string (povinné)
typ šifrování Typ šifrování, který se má provést. Např - deterministický, randomizovaný. string (povinné)
cesta Cesta, která musí být šifrovaná. string (povinné)

Zásady šifrování klienta

Jméno Popis Hodnota
includedPaths Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu. ClientEncryptionIncludedPath[] (povinné)
Verze policyFormatVersion Verze definice zásad šifrování klienta Podporované verze jsou 1 a 2. Verze 2 podporuje šifrování cesty id a klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2 (povinné)

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

Kompozitní cesta

Jméno Popis Hodnota
pořadí Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ComputedProperty

Jméno Popis Hodnota
Jméno Název počítané vlastnosti, například cp_lowerName řetězec
dotaz Dotaz, který vyhodnotí hodnotu pro vypočítanou vlastnost, například – SELECT VALUE LOWER(c.name) FROM c řetězec

Zásady řešení konfliktů

Jméno Popis Hodnota
Cesta řešení konfliktů Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure (Postup řešení) konfliktu Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

Klíč kontejnerového oddílu

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru řetězec[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

Zásady maskování dat

Jméno Popis Hodnota
vyloučené_cesty Seznam cest JSON, které se mají vyloučit z maskování. Položka DataMaskingPolicyExcludedPaths[]
includedPaths Seznam cest JSON, které se mají zahrnout do zásad maskování. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Příznak označující, zda je povolena zásada maskování dat. Bool

Položka DataMaskingPolicyExcludedPathsItem

Jméno Popis Hodnota
cesta Cesta JSON, která se má vyloučit z maskování (např. "/id"). string (povinné)

DataMaskingPolicyIncludedPathsItem

Jméno Popis Hodnota
length Délka podřetězce k masce (pokud je to možné). Int
cesta Cesta JSON pro použití maskování (např. "/contact/phones"). string (povinné)
startPozice Počáteční pozice pro maskování podřetězců (pokud je to možné). Int
strategy Použít maskovací strategii (např. "MaskSubstring"). řetězec

Vyloučená_cesta

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

FullTextIndexPath

Jméno Popis Hodnota
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPath

Jméno Popis Hodnota
jazyk Jazyk úplného textového pole v dokumentu. řetězec
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPolicy

Jméno Popis Hodnota
defaultLanguage Výchozí jazyk pro úplnou textovou cestu. řetězec
PlnéTextové cesty Seznam cest fulltextu FullTextPath[]

Zahrnutá_cesta

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

Indexovací politika

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
fullTextIndexes Seznam cest, které mají být zahrnuty do indexování fulltextu FullTextIndexPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování ZahrnutáCesta[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'žádný'
prostorové indexy Seznam prostorových specifik ProstorovéSpec[]
vectorIndexy Seznam cest, které se mají zahrnout do indexování vektorů Vektorový_index[]

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
uživatelem přiřazené identity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

MaterializedViewDefinition

Jméno Popis Hodnota
definice Definice by měla být dotaz SQL, který by se použil k načtení dat ze zdrojového kontejneru k naplnění do kontejneru Materialized View. string (povinné)
sourceCollectionId Název zdrojového kontejneru, na kterém se vytvoří materializované zobrazení. string (povinné)
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení v cílovém kontejneru. Int

MaterializedViewDetails

Jméno Popis Hodnota
identifikační číslo Pole ID materializovaného kontejneru řetězec
_zbavit _rid pole materializovaného kontejneru. řetězec

MaterializedViewsProperties

Jméno Popis Hodnota
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení ve zdrojovém kontejneru. Int

Parametry obnovení prostředků

Jméno Popis Hodnota
Zdroj obnovení ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Prostorová specifikace

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
Zásady šifrování klienta Zásady šifrování klienta pro kontejner. Zásady šifrování klienta
computedProperties Seznam vypočítaných vlastností Vypočtená_vlastnost[]
zásady řešení konfliktů Zásady řešení konfliktů pro kontejner. Zásady řešení konfliktů
Režim createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
Zásady maskování dat Zásady maskování dat pro kontejner. Zásady maskování dat
defaultTtl Výchozí čas k živému provozu Int
fullTextPolicy Zásady fulltextu pro kontejner. FullTextPolicy
identifikační číslo Název kontejneru SQL služby Cosmos DB string (povinné)
zásady indexování Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. Musí být zadán pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
materializedViews Materializovaná zobrazení definovaná v kontejneru MaterializedViewDetails[]
materializedViewsProperties Materializovaná zobrazení: Vlastnosti definované pro zdrojový kontejner. MaterializedViewsProperties
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů Klíč kontejnerového oddílu
Parametry obnovení Parametry označující informace o obnovení Parametry obnovení prostředků
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Zásada vkládání vektorů pro kontejner. Zásady vektorového vkládání

Visačky

Jméno Popis Hodnota

Jedinečný klíč

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB Jedinečný klíč[]

Vektorové vkládání

Jméno Popis Hodnota
Datatype Označuje datový typ vektoru. Float16
Float32
"int8"
'uint8' (povinné)
dimenze Počet dimenzí ve vektoru. int (povinné)
vzdálenostFunction Funkce vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory. "kosinus"
'dotproduct'
Euclidean (povinné)
cesta Cesta k vektorovém poli v dokumentu. string (povinné)

Zásady vektorového vkládání

Jméno Popis Hodnota
vektorové vkládání Seznam vektorových vkládání Vektorové vložení[]

Vektorový index

Jméno Popis Hodnota
indexingSearchListSize Jedná se o velikost seznamu kandidátů přibližných sousedů uloženého při vytváření indexu DiskANN v rámci optimalizačních procesů. Velké hodnoty mohou zlepšit úplnost na úkor latence. To platí pouze pro typ vektorového indexu diskANN. Int

Omezení:
Minimální hodnota = 25
Maximální hodnota = 500
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
KvantizaceByteSize Počet bajtů použitých při kvantizaci součinu vektorů. Vyšší hodnota může mít za následek lepší zapamatování vektorových vyhledávání na úkor latence. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. Int

Omezení:
Minimální hodnota = 4
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)
vectorIndexShardKey Pole klíčů horizontálních oddílů pro vektorový index. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. řetězec[]

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
Vytvoření účtu služby Azure Cosmos DB úrovně Free Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL) Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/sqlDatabases/containers je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, přidejte do šablony následující kód JSON.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2025-11-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",
      "dataMaskingPolicy": {
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "length": "int",
            "path": "string",
            "startPosition": "int",
            "strategy": "string"
          }
        ],
        "isPolicyEnabled": "bool"
      },
      "defaultTtl": "int",
      "fullTextPolicy": {
        "defaultLanguage": "string",
        "fullTextPaths": [
          {
            "language": "string",
            "path": "string"
          }
        ]
      },
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "fullTextIndexes": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "indexingSearchListSize": "int",
            "path": "string",
            "quantizationByteSize": "int",
            "type": "string",
            "vectorIndexShardKey": [ "string" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string",
        "throughputBucketForBuild": "int"
      },
      "materializedViews": [
        {
          "id": "string",
          "_rid": "string"
        }
      ],
      "materializedViewsProperties": {
        "throughputBucketForBuild": "int"
      },
      "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"
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API "2025-11-01-preview"
identita Identita prostředku ManagedServiceIdentity
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB sqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Zahrnutá cesta ke šifrování klienta

Jméno Popis Hodnota
ID klíče šifrování klienta Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty. string (povinné)
šifrovacíchAlgoritmů Šifrovací algoritmus, který se použije. Např - AEAD_AES_256_CBC_HMAC_SHA256. string (povinné)
typ šifrování Typ šifrování, který se má provést. Např - deterministický, randomizovaný. string (povinné)
cesta Cesta, která musí být šifrovaná. string (povinné)

Zásady šifrování klienta

Jméno Popis Hodnota
includedPaths Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu. ClientEncryptionIncludedPath[] (povinné)
Verze policyFormatVersion Verze definice zásad šifrování klienta Podporované verze jsou 1 a 2. Verze 2 podporuje šifrování cesty id a klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2 (povinné)

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

Kompozitní cesta

Jméno Popis Hodnota
pořadí Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ComputedProperty

Jméno Popis Hodnota
Jméno Název počítané vlastnosti, například cp_lowerName řetězec
dotaz Dotaz, který vyhodnotí hodnotu pro vypočítanou vlastnost, například – SELECT VALUE LOWER(c.name) FROM c řetězec

Zásady řešení konfliktů

Jméno Popis Hodnota
Cesta řešení konfliktů Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure (Postup řešení) konfliktu Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

Klíč kontejnerového oddílu

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru řetězec[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

Zásady maskování dat

Jméno Popis Hodnota
vyloučené_cesty Seznam cest JSON, které se mají vyloučit z maskování. Položka DataMaskingPolicyExcludedPaths[]
includedPaths Seznam cest JSON, které se mají zahrnout do zásad maskování. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Příznak označující, zda je povolena zásada maskování dat. Bool

Položka DataMaskingPolicyExcludedPathsItem

Jméno Popis Hodnota
cesta Cesta JSON, která se má vyloučit z maskování (např. "/id"). string (povinné)

DataMaskingPolicyIncludedPathsItem

Jméno Popis Hodnota
length Délka podřetězce k masce (pokud je to možné). Int
cesta Cesta JSON pro použití maskování (např. "/contact/phones"). string (povinné)
startPozice Počáteční pozice pro maskování podřetězců (pokud je to možné). Int
strategy Použít maskovací strategii (např. "MaskSubstring"). řetězec

Vyloučená_cesta

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

FullTextIndexPath

Jméno Popis Hodnota
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPath

Jméno Popis Hodnota
jazyk Jazyk úplného textového pole v dokumentu. řetězec
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPolicy

Jméno Popis Hodnota
defaultLanguage Výchozí jazyk pro úplnou textovou cestu. řetězec
PlnéTextové cesty Seznam cest fulltextu FullTextPath[]

Zahrnutá_cesta

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

Indexovací politika

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
fullTextIndexes Seznam cest, které mají být zahrnuty do indexování fulltextu FullTextIndexPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování ZahrnutáCesta[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'žádný'
prostorové indexy Seznam prostorových specifik ProstorovéSpec[]
vectorIndexy Seznam cest, které se mají zahrnout do indexování vektorů Vektorový_index[]

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
uživatelem přiřazené identity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

MaterializedViewDefinition

Jméno Popis Hodnota
definice Definice by měla být dotaz SQL, který by se použil k načtení dat ze zdrojového kontejneru k naplnění do kontejneru Materialized View. string (povinné)
sourceCollectionId Název zdrojového kontejneru, na kterém se vytvoří materializované zobrazení. string (povinné)
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení v cílovém kontejneru. Int

MaterializedViewDetails

Jméno Popis Hodnota
identifikační číslo Pole ID materializovaného kontejneru řetězec
_zbavit _rid pole materializovaného kontejneru. řetězec

MaterializedViewsProperties

Jméno Popis Hodnota
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení ve zdrojovém kontejneru. Int

Parametry obnovení prostředků

Jméno Popis Hodnota
Zdroj obnovení ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Prostorová specifikace

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
Zásady šifrování klienta Zásady šifrování klienta pro kontejner. Zásady šifrování klienta
computedProperties Seznam vypočítaných vlastností Vypočtená_vlastnost[]
zásady řešení konfliktů Zásady řešení konfliktů pro kontejner. Zásady řešení konfliktů
Režim createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
Zásady maskování dat Zásady maskování dat pro kontejner. Zásady maskování dat
defaultTtl Výchozí čas k živému provozu Int
fullTextPolicy Zásady fulltextu pro kontejner. FullTextPolicy
identifikační číslo Název kontejneru SQL služby Cosmos DB string (povinné)
zásady indexování Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. Musí být zadán pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
materializedViews Materializovaná zobrazení definovaná v kontejneru MaterializedViewDetails[]
materializedViewsProperties Materializovaná zobrazení: Vlastnosti definované pro zdrojový kontejner. MaterializedViewsProperties
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů Klíč kontejnerového oddílu
Parametry obnovení Parametry označující informace o obnovení Parametry obnovení prostředků
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Zásada vkládání vektorů pro kontejner. Zásady vektorového vkládání

Visačky

Jméno Popis Hodnota

Jedinečný klíč

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB Jedinečný klíč[]

Vektorové vkládání

Jméno Popis Hodnota
Datatype Označuje datový typ vektoru. Float16
Float32
"int8"
'uint8' (povinné)
dimenze Počet dimenzí ve vektoru. int (povinné)
vzdálenostFunction Funkce vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory. "kosinus"
'dotproduct'
Euclidean (povinné)
cesta Cesta k vektorovém poli v dokumentu. string (povinné)

Zásady vektorového vkládání

Jméno Popis Hodnota
vektorové vkládání Seznam vektorových vkládání Vektorové vložení[]

Vektorový index

Jméno Popis Hodnota
indexingSearchListSize Jedná se o velikost seznamu kandidátů přibližných sousedů uloženého při vytváření indexu DiskANN v rámci optimalizačních procesů. Velké hodnoty mohou zlepšit úplnost na úkor latence. To platí pouze pro typ vektorového indexu diskANN. Int

Omezení:
Minimální hodnota = 25
Maximální hodnota = 500
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
KvantizaceByteSize Počet bajtů použitých při kvantizaci součinu vektorů. Vyšší hodnota může mít za následek lepší zapamatování vektorových vyhledávání na úkor latence. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. Int

Omezení:
Minimální hodnota = 4
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)
vectorIndexShardKey Pole klíčů horizontálních oddílů pro vektorový index. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. řetězec[]

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště

nasazení do Azure
Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní API core (SQL) s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
Vytvoření účtu služby Azure Cosmos DB úrovně Free

nasazení do Azure
Tato šablona vytvoří účet služby Azure Cosmos DB úrovně Free pro rozhraní SQL API s databází se sdílenou propustností a kontejnerem.
vytvoření účtu služby Azure Cosmos DB pro rozhraní CORE (SQL) API

nasazení do Azure
Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
Vytvoření rozhraní SQL API účtu služby Azure Cosmos DB s automatickým škálováním

nasazení do Azure
Tato šablona vytvoří účet Azure Cosmos PRO rozhraní API core (SQL) s databází a kontejnerem s propustností automatického škálování s několika dalšími možnostmi.
vytvoření uložených procedur rozhraní API služby Azure Cosmos DB Core (SQL)

nasazení do Azure
Tato šablona vytvoří účet služby Azure Cosmos DB pro rozhraní CORE (SQL) API a kontejner s uloženou procedurou, triggerem a uživatelem definovanou funkcí.
vytvoří aplikaci mikroslužeb Dapr pomocí služby Container Apps

nasazení do Azure
Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps

nasazení do Azure
Vytvořte aplikaci Dapr pub-sub servicebus pomocí Container Apps.
nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

nasazení do Azure
Nasaďte databázi Azure Data Exploreru s připojením ke službě Cosmos DB.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/sqlDatabases/containers je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
        dataMaskingPolicy = {
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              length = int
              path = "string"
              startPosition = int
              strategy = "string"
            }
          ]
          isPolicyEnabled = bool
        }
        defaultTtl = int
        fullTextPolicy = {
          defaultLanguage = "string"
          fullTextPaths = [
            {
              language = "string"
              path = "string"
            }
          ]
        }
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          fullTextIndexes = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              indexingSearchListSize = int
              path = "string"
              quantizationByteSize = int
              type = "string"
              vectorIndexShardKey = [
                "string"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
          throughputBucketForBuild = int
        }
        materializedViews = [
          {
            id = "string"
            _rid = "string"
          }
        ]
        materializedViewsProperties = {
          throughputBucketForBuild = int
        }
        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"
            }
          ]
        }
      }
    }
  }
}

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno Popis Hodnota
identita Identita prostředku ManagedServiceIdentity
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
Jméno Název prostředku string (povinné)
ID rodiče ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts/sqlDatabases
vlastnosti Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB sqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-11-01-preview"

Automatické škálováníSettings

Jméno Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. Int

Zahrnutá cesta ke šifrování klienta

Jméno Popis Hodnota
ID klíče šifrování klienta Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty. string (povinné)
šifrovacíchAlgoritmů Šifrovací algoritmus, který se použije. Např - AEAD_AES_256_CBC_HMAC_SHA256. string (povinné)
typ šifrování Typ šifrování, který se má provést. Např - deterministický, randomizovaný. string (povinné)
cesta Cesta, která musí být šifrovaná. string (povinné)

Zásady šifrování klienta

Jméno Popis Hodnota
includedPaths Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu. ClientEncryptionIncludedPath[] (povinné)
Verze policyFormatVersion Verze definice zásad šifrování klienta Podporované verze jsou 1 a 2. Verze 2 podporuje šifrování cesty id a klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2 (povinné)

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Jméno Popis Hodnota

Kompozitní cesta

Jméno Popis Hodnota
pořadí Pořadí řazení složených cest Vzestupně
Sestupně
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

ComputedProperty

Jméno Popis Hodnota
Jméno Název počítané vlastnosti, například cp_lowerName řetězec
dotaz Dotaz, který vyhodnotí hodnotu pro vypočítanou vlastnost, například – SELECT VALUE LOWER(c.name) FROM c řetězec

Zásady řešení konfliktů

Jméno Popis Hodnota
Cesta řešení konfliktů Cesta řešení konfliktů v případě režimu LastWriterWins. řetězec
conflictResolutionProcedure (Postup řešení) konfliktu Postup řešení konfliktů v případě vlastního režimu. řetězec
režim Označuje režim řešení konfliktů. Vlastní
LastWriterWins

Klíč kontejnerového oddílu

Jméno Popis Hodnota
laskavý Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři). "Hash"
MultiHash
"Rozsah"
stezky Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru řetězec[]
verze Označuje verzi definice klíče oddílu. Int

Omezení:
Minimální hodnota = 1
Maximální hodnota = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Jméno Popis Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se propustnost nebo automatické škálováníSettings, ale ne obojí. automatického škálování
propustnost Jednotky žádostí za sekundu Například propustnost: 1 0000. Int

Zásady maskování dat

Jméno Popis Hodnota
vyloučené_cesty Seznam cest JSON, které se mají vyloučit z maskování. Položka DataMaskingPolicyExcludedPaths[]
includedPaths Seznam cest JSON, které se mají zahrnout do zásad maskování. DataMaskingPolicyIncludedPathsItem[]
isPolicyEnabled Příznak označující, zda je povolena zásada maskování dat. Bool

Položka DataMaskingPolicyExcludedPathsItem

Jméno Popis Hodnota
cesta Cesta JSON, která se má vyloučit z maskování (např. "/id"). string (povinné)

DataMaskingPolicyIncludedPathsItem

Jméno Popis Hodnota
length Délka podřetězce k masce (pokud je to možné). Int
cesta Cesta JSON pro použití maskování (např. "/contact/phones"). string (povinné)
startPozice Počáteční pozice pro maskování podřetězců (pokud je to možné). Int
strategy Použít maskovací strategii (např. "MaskSubstring"). řetězec

Vyloučená_cesta

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

FullTextIndexPath

Jméno Popis Hodnota
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPath

Jméno Popis Hodnota
jazyk Jazyk úplného textového pole v dokumentu. řetězec
cesta Cesta k úplnému textovému poli v dokumentu. string (povinné)

FullTextPolicy

Jméno Popis Hodnota
defaultLanguage Výchozí jazyk pro úplnou textovou cestu. řetězec
PlnéTextové cesty Seznam cest fulltextu FullTextPath[]

Zahrnutá_cesta

Jméno Popis Hodnota
indexy Seznam indexů pro tuto cestu indexy []
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec

Indexy

Jméno Popis Hodnota
Datatype Datový typ, na který se používá chování indexování. 'LineString'
MultiPolygon
'Číslo'
"Point"
"Mnohoúhelník"
Řetězec
laskavý Určuje typ indexu. "Hash"
"Rozsah"
Prostorový
přesnost Přesnost indexu. -1 je maximální přesnost. Int

Indexovací politika

Jméno Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Bool
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
fullTextIndexes Seznam cest, které mají být zahrnuty do indexování fulltextu FullTextIndexPath[]
includedPaths Seznam cest, které se mají zahrnout do indexování ZahrnutáCesta[]
indexingMode Označuje režim indexování. "konzistentní"
"Opožděný"
'žádný'
prostorové indexy Seznam prostorových specifik ProstorovéSpec[]
vectorIndexy Seznam cest, které se mají zahrnout do indexování vektorů Vektorový_index[]

ManagedServiceIdentity

Jméno Popis Hodnota
typ Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere ze služby všechny identity. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
uživatelem přiřazené identity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formátu: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Jméno Popis Hodnota

MaterializedViewDefinition

Jméno Popis Hodnota
definice Definice by měla být dotaz SQL, který by se použil k načtení dat ze zdrojového kontejneru k naplnění do kontejneru Materialized View. string (povinné)
sourceCollectionId Název zdrojového kontejneru, na kterém se vytvoří materializované zobrazení. string (povinné)
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení v cílovém kontejneru. Int

MaterializedViewDetails

Jméno Popis Hodnota
identifikační číslo Pole ID materializovaného kontejneru řetězec
_zbavit _rid pole materializovaného kontejneru. řetězec

MaterializedViewsProperties

Jméno Popis Hodnota
throughputBucketForBuild Kontejner propustnosti přiřazený pro operace materializovaného zobrazení ve zdrojovém kontejneru. Int

Parametry obnovení prostředků

Jméno Popis Hodnota
Zdroj obnovení ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas obnovení účtu (formát ISO-8601) řetězec
restoreWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live. Bool

Prostorová specifikace

Jméno Popis Hodnota
cesta Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*) řetězec
typy Seznam prostorového typu cesty Řetězcové pole obsahující některou z těchto možností:
'LineString'
MultiPolygon
"Point"
"Mnohoúhelník"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Jméno Popis Hodnota
volby Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. Int
Zásady šifrování klienta Zásady šifrování klienta pro kontejner. Zásady šifrování klienta
computedProperties Seznam vypočítaných vlastností Vypočtená_vlastnost[]
zásady řešení konfliktů Zásady řešení konfliktů pro kontejner. Zásady řešení konfliktů
Režim createMode Výčet označující režim vytváření prostředků. Výchozí
Obnovit
Zásady maskování dat Zásady maskování dat pro kontejner. Zásady maskování dat
defaultTtl Výchozí čas k živému provozu Int
fullTextPolicy Zásady fulltextu pro kontejner. FullTextPolicy
identifikační číslo Název kontejneru SQL služby Cosmos DB string (povinné)
zásady indexování Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. Musí být zadán pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
materializedViews Materializovaná zobrazení definovaná v kontejneru MaterializedViewDetails[]
materializedViewsProperties Materializovaná zobrazení: Vlastnosti definované pro zdrojový kontejner. MaterializedViewsProperties
partitionKey Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů Klíč kontejnerového oddílu
Parametry obnovení Parametry označující informace o obnovení Parametry obnovení prostředků
uniqueKeyPolicy Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Zásada vkládání vektorů pro kontejner. Zásady vektorového vkládání

Visačky

Jméno Popis Hodnota

Jedinečný klíč

Jméno Popis Hodnota
stezky Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Jméno Popis Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB Jedinečný klíč[]

Vektorové vkládání

Jméno Popis Hodnota
Datatype Označuje datový typ vektoru. Float16
Float32
"int8"
'uint8' (povinné)
dimenze Počet dimenzí ve vektoru. int (povinné)
vzdálenostFunction Funkce vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory. "kosinus"
'dotproduct'
Euclidean (povinné)
cesta Cesta k vektorovém poli v dokumentu. string (povinné)

Zásady vektorového vkládání

Jméno Popis Hodnota
vektorové vkládání Seznam vektorových vkládání Vektorové vložení[]

Vektorový index

Jméno Popis Hodnota
indexingSearchListSize Jedná se o velikost seznamu kandidátů přibližných sousedů uloženého při vytváření indexu DiskANN v rámci optimalizačních procesů. Velké hodnoty mohou zlepšit úplnost na úkor latence. To platí pouze pro typ vektorového indexu diskANN. Int

Omezení:
Minimální hodnota = 25
Maximální hodnota = 500
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
KvantizaceByteSize Počet bajtů použitých při kvantizaci součinu vektorů. Vyšší hodnota může mít za následek lepší zapamatování vektorových vyhledávání na úkor latence. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. Int

Omezení:
Minimální hodnota = 4
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)
vectorIndexShardKey Pole klíčů horizontálních oddílů pro vektorový index. To platí pouze pro vektorové indexy typu quantizedFlat a diskANN. řetězec[]

Příklady použití

Ukázky Terraformu

Základní příklad nasazení kontejneru SQL v rámci účtu Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
        throughput = 400
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "container" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  parent_id = azapi_resource.sqlDatabase.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = "test-containerWest Europe"
        partitionKey = {
          kind = "Hash"
          paths = [
            "/definition",
          ]
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}