Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

Článek
12/20/2024

nejnovější
12. 12. 2024 ve verzi Preview
11. 11. 2024
2024-09-01-preview
1 5. 8. 2024
15. 5. 2024
15. 5. 2024 ve verzi Preview
2024-024-15-preview
11. 11. 2023
11. 11. 2023 ve verzi Preview
15. 9. 2023
2023-09-15-preview
2023-04-15
15. 3. 2023
2023-03-15-preview
1. 3. 2023 ve verzi Preview
11. 11. 2022
11. 11. 2022 ve verzi Preview
2022-08-15
15. 8. 2022 ve verzi Preview
15. 5. 2022
2022-05-15-preview
2022-022-15-preview
11. 11. 2021 ve verzi Preview
10. 10. 2021
10. 10. 2021 ve verzi Preview
2021-07-01-preview
15. 6. 2021
2021-05-15
2021-04-15
2021-04-01-preview
15. 3. 2021
2021-03-01-preview
15. 1 5. 2021
2020-09-01
2020-06-01-preview
04.04.2020
2020-03-01
12. 12. 2019
1. 8. 2019

Definice prostředku Bicep

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

skupiny prostředků – viz příkazy nasazení skupiny prostředků

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@2024-12-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            path: 'string'
            type: 'string'
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
      vectorEmbeddingPolicy: {
        vectorEmbeddings: [
          {
            dataType: 'string'
            dimensions: int
            distanceFunction: 'string'
            path: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

Jméno	Popis	Hodnota
includedPaths	Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu.	ClientEncryptionIncludedPath[] (povinné)
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

CompositePath

Jméno	Popis	Hodnota
objednávka	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

ConflictResolutionPolicy

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

ContainerPartitionKey

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	string[]
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

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Jméno	Popis	Hodnota
automatický	Označuje, jestli je zásada indexování automatická.	Bool
compositeIndexes	Seznam složených cest	CompositePath[][]
excludedPaths	Seznam cest, které se mají vyloučit z indexování	ExcludedPath[]
includedPaths	Seznam cest, které se mají zahrnout do indexování	IncludedPath[]
indexingMode	Označuje režim indexování.	"konzistentní" "Opožděný" 'none'
spatialIndexes	Seznam prostorových specifik	SpatialSpec[]
vectorIndexes	Seznam cest, které se mají zahrnout do indexování vektorů	VectorIndex[]

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
userAssignedIdentities	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é)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno	Popis	Hodnota
identita	Identita prostředku	ManagedServiceIdentity
umístění	Umístění skupiny prostředků, do které prostředek patří.	řetězec
Jméno	Název prostředku	string (povinné)
rodič	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

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	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

SpatialSpec

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
zdroj	Standardní formát JSON kontejneru	SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
clientEncryptionPolicy	Zásady šifrování klienta pro kontejner.	ClientEncryptionPolicy
computedProperties	Seznam vypočítaných vlastností	ComputedProperty[]
conflictResolutionPolicy	Zásady řešení konfliktů pro kontejner.	ConflictResolutionPolicy
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
defaultTtl	Výchozí čas k živému provozu	Int
id	Název kontejneru SQL služby Cosmos DB	string (povinné)
indexingPolicy	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
partitionKey	Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů	ContainerPartitionKey
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
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.	VectorEmbeddingPolicy

Visačky

Jméno	Popis	Hodnota

UniqueKey

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

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	UniqueKey[]

VectorEmbedding

Jméno	Popis	Hodnota
Datatype	Označuje datový typ vektoru.	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é)

VectorEmbeddingPolicy

Jméno	Popis	Hodnota
vectorEmbeddings	Seznam vektorových vkládání	VectorEmbedding[]

VectorIndex

Jméno	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é)

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ 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í:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

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": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "path": "string",
            "type": "string"
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      },
      "vectorEmbeddingPolicy": {
        "vectorEmbeddings": [
          {
            "dataType": "string",
            "dimensions": "int",
            "distanceFunction": "string",
            "path": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

Jméno	Popis	Hodnota
includedPaths	Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu.	ClientEncryptionIncludedPath[] (povinné)
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

CompositePath

Jméno	Popis	Hodnota
objednávka	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

ConflictResolutionPolicy

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

ContainerPartitionKey

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	string[]
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

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Jméno	Popis	Hodnota
automatický	Označuje, jestli je zásada indexování automatická.	Bool
compositeIndexes	Seznam složených cest	CompositePath[][]
excludedPaths	Seznam cest, které se mají vyloučit z indexování	ExcludedPath[]
includedPaths	Seznam cest, které se mají zahrnout do indexování	IncludedPath[]
indexingMode	Označuje režim indexování.	"konzistentní" "Opožděný" 'none'
spatialIndexes	Seznam prostorových specifik	SpatialSpec[]
vectorIndexes	Seznam cest, které se mají zahrnout do indexování vektorů	VectorIndex[]

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
userAssignedIdentities	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é)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	2024-12-01-preview
identita	Identita prostředku	ManagedServiceIdentity
umístění	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

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	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

SpatialSpec

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
zdroj	Standardní formát JSON kontejneru	SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
clientEncryptionPolicy	Zásady šifrování klienta pro kontejner.	ClientEncryptionPolicy
computedProperties	Seznam vypočítaných vlastností	ComputedProperty[]
conflictResolutionPolicy	Zásady řešení konfliktů pro kontejner.	ConflictResolutionPolicy
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
defaultTtl	Výchozí čas k živému provozu	Int
id	Název kontejneru SQL služby Cosmos DB	string (povinné)
indexingPolicy	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
partitionKey	Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů	ContainerPartitionKey
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
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.	VectorEmbeddingPolicy

Visačky

Jméno	Popis	Hodnota

UniqueKey

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

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	UniqueKey[]

VectorEmbedding

Jméno	Popis	Hodnota
Datatype	Označuje datový typ vektoru.	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é)

VectorEmbeddingPolicy

Jméno	Popis	Hodnota
vectorEmbeddings	Seznam vektorových vkládání	VectorEmbedding[]

VectorIndex

Jméno	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é)

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona	Popis
rozhraní SQL API účtu služby Azure Cosmos DB s analytického úložiště nasazení	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í	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í	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í	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í	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í	Vytvořte aplikaci mikroslužeb Dapr pomocí Container Apps.
vytvoří aplikaci Dapr pub-sub servicebus pomocí služby Container Apps nasazení	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í	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í:

skupiny prostředků

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@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              path = "string"
              type = "string"
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
        vectorEmbeddingPolicy = {
          vectorEmbeddings = [
            {
              dataType = "string"
              dimensions = int
              distanceFunction = "string"
              path = "string"
            }
          ]
        }
      }
    }
  })
}

Hodnoty vlastností

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

ClientEncryptionIncludedPath

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

ClientEncryptionPolicy

Jméno	Popis	Hodnota
includedPaths	Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu.	ClientEncryptionIncludedPath[] (povinné)
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

CompositePath

Jméno	Popis	Hodnota
objednávka	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

ConflictResolutionPolicy

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

ContainerPartitionKey

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	string[]
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

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Jméno	Popis	Hodnota
automatický	Označuje, jestli je zásada indexování automatická.	Bool
compositeIndexes	Seznam složených cest	CompositePath[][]
excludedPaths	Seznam cest, které se mají vyloučit z indexování	ExcludedPath[]
includedPaths	Seznam cest, které se mají zahrnout do indexování	IncludedPath[]
indexingMode	Označuje režim indexování.	"konzistentní" "Opožděný" 'none'
spatialIndexes	Seznam prostorových specifik	SpatialSpec[]
vectorIndexes	Seznam cest, které se mají zahrnout do indexování vektorů	VectorIndex[]

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
userAssignedIdentities	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é)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Jméno	Popis	Hodnota
identita	Identita prostředku	ManagedServiceIdentity
umístění	Umístění skupiny prostředků, do které prostředek patří.	řetězec
Jméno	Název prostředku	string (povinné)
parent_id	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@2024-12-01-preview

ResourceRestoreParameters

Jméno	Popis	Hodnota
restoreSource	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

SpatialSpec

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
zdroj	Standardní formát JSON kontejneru	SqlContainerResourceOrSqlContainerGetPropertiesResource (povinné)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Jméno	Popis	Hodnota
analyticalStorageTtl	Hodnota TTL analytického úložiště.	Int
clientEncryptionPolicy	Zásady šifrování klienta pro kontejner.	ClientEncryptionPolicy
computedProperties	Seznam vypočítaných vlastností	ComputedProperty[]
conflictResolutionPolicy	Zásady řešení konfliktů pro kontejner.	ConflictResolutionPolicy
createMode	Výčet označující režim vytváření prostředků.	Výchozí Obnovit
defaultTtl	Výchozí čas k živému provozu	Int
id	Název kontejneru SQL služby Cosmos DB	string (povinné)
indexingPolicy	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
partitionKey	Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů	ContainerPartitionKey
restoreParameters	Parametry označující informace o obnovení	ResourceRestoreParameters
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.	VectorEmbeddingPolicy

Visačky

Jméno	Popis	Hodnota

UniqueKey

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

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	UniqueKey[]

VectorEmbedding

Jméno	Popis	Hodnota
Datatype	Označuje datový typ vektoru.	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é)

VectorEmbeddingPolicy

Jméno	Popis	Hodnota
vectorEmbeddings	Seznam vektorových vkládání	VectorEmbedding[]

VectorIndex

Jméno	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é)

Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

Automatické škálováníSettings

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath

IncludedPath

Indexy

IndexingPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

MaterializedViewDefinition

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

ResourceRestoreParameters

SpatialSpec

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Visačky

UniqueKey

UniqueKeyPolicy

VectorEmbedding

VectorEmbeddingPolicy

VectorIndex

Ukázky rychlého startu

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

Automatické škálováníSettings

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath

IncludedPath

Indexy

IndexingPolicy

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

MaterializedViewDefinition

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

ResourceRestoreParameters

SpatialSpec

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Visačky

UniqueKey

UniqueKeyPolicy

VectorEmbedding

VectorEmbeddingPolicy

VectorIndex

Šablony pro rychlý start

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

Automatické škálováníSettings

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Komponenty1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty

ConflictResolutionPolicy

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath

IncludedPath

Indexy

IndexingPolicy