Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2025-04-15

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-04-15' = {
  parent: resourceSymbolicName
  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
      fullTextPolicy: {
        defaultLanguage: 'string'
        fullTextPaths: [
          {
            language: 'string'
            path: 'string'
          }
        ]
      }
      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'
          }
        ]
      }
      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

Název Popis Hodnota
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
název 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é)
štítky Štítky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Automatické škálováníSettings

Název Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. int (integer)

Zahrnutá cesta ke šifrování klienta

Název 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

Název 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é)

Kompozitní cesta

Název 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

Název Popis Hodnota
název 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ů

Název 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

Název 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"
cesty 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

Název 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 (integer)

Vyloučená_cesta

Název 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

FullTextPath

Název 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

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

Zahrnutá_cesta

Název 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

Rejstříky

Název Popis Hodnota
datový typ 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 (integer)

Indexovací politika

Název Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Booleova hodnota
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
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[]

Parametry obnovení prostředků

Název 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. Booleova hodnota

Prostorová specifikace

Název 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

Název Popis Hodnota
možnosti 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

Název Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int (integer)
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
defaultTtl Výchozí čas k živému provozu int (integer)
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
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í

Štítky

Název Popis Hodnota

Jedinečný klíč

Název Popis Hodnota
cesty Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Název 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í

Název Popis Hodnota
datový typ Označuje datový typ vektoru. Float32
"int8"
'uint8' (povinné)
rozměry 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í

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

Vektorový index

Název Popis Hodnota
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)

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-04-15",
  "name": "string",
  "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",
      "fullTextPolicy": {
        "defaultLanguage": "string",
        "fullTextPaths": [
          {
            "language": "string",
            "path": "string"
          }
        ]
      },
      "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"
          }
        ]
      },
      "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

Název Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API '2025-04-15'
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
název Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB sqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (povinné)
štítky Štítky 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

Název Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. int (integer)

Zahrnutá cesta ke šifrování klienta

Název 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

Název 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é)

Kompozitní cesta

Název 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

Název Popis Hodnota
název 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ů

Název 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

Název 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"
cesty 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

Název 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 (integer)

Vyloučená_cesta

Název 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

FullTextPath

Název 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

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

Zahrnutá_cesta

Název 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

Rejstříky

Název Popis Hodnota
datový typ 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 (integer)

Indexovací politika

Název Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Booleova hodnota
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
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[]

Parametry obnovení prostředků

Název 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. Booleova hodnota

Prostorová specifikace

Název 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

Název Popis Hodnota
možnosti 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

Název Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int (integer)
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
defaultTtl Výchozí čas k živému provozu int (integer)
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
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í

Štítky

Název Popis Hodnota

Jedinečný klíč

Název Popis Hodnota
cesty Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Název 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í

Název Popis Hodnota
datový typ Označuje datový typ vektoru. Float32
"int8"
'uint8' (povinné)
rozměry 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í

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

Vektorový index

Název Popis Hodnota
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)

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-04-15"
  name = "string"
  parent_id = "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"
        defaultTtl = int
        fullTextPolicy = {
          defaultLanguage = "string"
          fullTextPaths = [
            {
              language = "string"
              path = "string"
            }
          ]
        }
        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"
            }
          ]
        }
        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

Název Popis Hodnota
poloha Umístění skupiny prostředků, do které prostředek patří. řetězec
název 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é)
štítky Štítky prostředků Slovník názvů a hodnot značek
typ Typ prostředku "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-04-15"

Automatické škálováníSettings

Název Popis Hodnota
maxThroughput Představuje maximální propustnost a prostředek se může vertikálně navýšit. int (integer)

Zahrnutá cesta ke šifrování klienta

Název 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

Název 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é)

Kompozitní cesta

Název 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

Název Popis Hodnota
název 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ů

Název 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

Název 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"
cesty 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

Název 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 (integer)

Vyloučená_cesta

Název 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

FullTextPath

Název 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

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

Zahrnutá_cesta

Název 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

Rejstříky

Název Popis Hodnota
datový typ 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 (integer)

Indexovací politika

Název Popis Hodnota
automatický Označuje, jestli je zásada indexování automatická. Booleova hodnota
compositeIndexes Seznam složených cest Kompozitní_cesta[][]
vyloučené_cesty Seznam cest, které se mají vyloučit z indexování Vyloučená_cesta[]
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[]

Parametry obnovení prostředků

Název 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. Booleova hodnota

Prostorová specifikace

Název 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

Název Popis Hodnota
možnosti 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

Název Popis Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int (integer)
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
defaultTtl Výchozí čas k živému provozu int (integer)
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
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í

Štítky

Název Popis Hodnota

Jedinečný klíč

Název Popis Hodnota
cesty Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. řetězec[]

UniqueKeyPolicy

Název 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í

Název Popis Hodnota
datový typ Označuje datový typ vektoru. Float32
"int8"
'uint8' (povinné)
rozměry 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í

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

Vektorový index

Název Popis Hodnota
cesta Cesta k vektorovém poli v dokumentu. string (povinné)
typ Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat. DiskANN
"byt"
QuantizedFlat (povinné)

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    = ["*"]
}
  • Last updated on