Databáze Microsoft.DocumentDBAccounts/sqlDatabases/containers

  • Článek

Definice prostředku Bicep

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

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-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/sqlDatabases/containers

Název Description Hodnota
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep.		 string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek. Zobrazit značky v šablonách
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí 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 sqlDatabases
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (povinné)

Identita spravované služby

Název Description Hodnota
typ 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
UserAssigned: Typ identity použité 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.
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResou... (povinné)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Název Description Hodnota
nastavení automatického škálování Určuje nastavení automatického škálování. Poznámka: Vyžaduje se buď propustnost, nebo nastavení automatického škálování, ale ne obojí. Nastavení automatického škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Nastavení automatického škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Název Description Hodnota
analyticalStorageTtl Hodnota TTL analytického úložiště. int
clientEncryptionPolicy Zásady šifrování klienta pro kontejner. ClientEncryptionPolicy
computedVlastnosti Seznam vypočítaných vlastností ComputedProperty[]
konfliktResolutionPolicy Zásady řešení konfliktů pro kontejner. KonfliktResolutionPolicy
createMode Výčet označující režim vytváření prostředků. 'Výchozí'
PointInTimeRestore
Obnovit
defaultTtl Výchozí hodnota TTL (Time to Live) int
id Název kontejneru SQL Cosmos DB string (povinné)
zásady indexování Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v kontejneru automatické. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. Toto musí být zadáno pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
partitionKey Konfigurace klíče oddílu, který se má použít k rozdělení dat do více oddílů Klíč oddílu kontejneru
obnoveníParameters Parametry označující informace o obnovení ResourceRestoreParameters
zásady jedinečného klíče Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

ClientEncryptionPolicy

Název Description Hodnota
includedPaths Cesty k položce, které vyžadují š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í id a cesty ke klíči oddílu. int (povinné)

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

ClientEncryptionIncludedPath

Název Description Hodnota
clientEncryptionKeyId Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty. string (povinné)
šifrováníAlgorithm Š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říklad – deterministický, randomizovaný. string (povinné)
program Cesta, která musí být zašifrovaná. string (povinné)

ComputedProperty

Název Description Hodnota
name Název vypočítané vlastnosti, například "cp_lowerName" řetězec
query Dotaz, který vyhodnocuje hodnotu vypočítané vlastnosti, například " SELECT VALUE LOWER(c.name) FROM c" řetězec

KonfliktResolutionPolicy

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

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli jsou zásady 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í. 'consistent'
"Líný"
'none' (žádný)
spatialIndexes Seznam prostorových specifik SpatialSpec[]

CompositePath

Název Description Hodnota
pořadí Pořadí řazení složených cest 'vzestupně'
'sestupně'
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

ExcludedPath

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

IncludedPath

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. 'LineString'
'MultiPolygon'
'Číslo'
"Bod"
'Mnohoúhelník'
'Řetězec'
Druhu Označuje typ indexu. 'Hash'
'Rozsah'
'Prostorové'
Přesnost Přesnost indexu. -1 je maximální přesnost. int

SpatialSpec

Název Description Hodnota
program Cesta, pro 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 Pole řetězců obsahující některou z těchto možností:
'LineString'
'MultiPolygon'
"Bod"
'Mnohoúhelník'

MaterializedViewDefinition

Název Description Hodnota
definice Definice by měla být dotaz SQL, který by se použil k načtení dat ze zdrojového kontejneru a naplnění do kontejneru Materialized View. string (povinné)
sourceCollectionId Název zdrojového kontejneru, ve kterém se materializované zobrazení vytvoří. string (povinné)

ContainerPartitionKey

Název Description Hodnota
Druhu Označuje typ algoritmu použitého k dělení. Pro 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é dělit data v kontejneru string[]
verze Označuje verzi definice klíče oddílu. int

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

ResourceRestoreParameters

Název Description Hodnota
restoreSource ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
restoreWithTtlDisabled Určuje, jestli bude obnovený účet po úspěšném obnovení zakázaný funkce Time-to-Live. bool

UniqueKeyPolicy

Název Description Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKey[]

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být jedinečný pro každý dokument ve službě Azure Cosmos DB. string[]

Šablony pro rychlý start

Následující šablony rychlého startu nasadí tento typ prostředku.

Template (Šablona) Description
Vytvoření účtu Služby Azure Cosmos DB úrovně Free

Nasazení do Azure		 Tato šablona vytvoří účet 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 služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem s propustností s několika dalšími možnostmi.
Rozhraní SQL API účtu služby Azure Cosmos DB s analytickým úložištěm

Nasazení do Azure		 Tato šablona vytvoří účet Služby Azure Cosmos pro rozhraní CORE (SQL) API s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
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 Služby Azure Cosmos pro rozhraní CORE (SQL) API 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 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í.
Nasazení služby Azure Data Explorer DB s připojením ke službě Cosmos DB

Nasazení do Azure		 Nasazení Azure Data Explorer DB 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í na:

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-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Hodnoty vlastností

databaseAccounts/sqlDatabases/containers

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
apiVersion Verze rozhraní API prostředku 2024-02-15-preview
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek. Zobrazit značky v šablonách
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci kontejneru Azure Cosmos DB SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (povinné)

Identita spravované služby

Název Description Hodnota
typ 'Žádný'
'SystemAssigned'
'SystemAssigned,UserAssigned'
UserAssigned: Typ identity použité 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.
userAssignedIdentity Seznam identit uživatelů přidružených k prostředku. Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu//subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentity

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se použijí pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResou... (povinné)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Název Description Hodnota
nastavení automatického škálování Určuje nastavení automatického škálování. Poznámka: Vyžaduje se buď propustnost, nebo nastavení automatického škálování, ale ne obojí. Nastavení automatického škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Nastavení automatického škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které se prostředek může vertikálně navýšit. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Název Description 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í
PointInTimeRestore
'Obnovit'
defaultTtl Výchozí hodnota time to Live int
id Název kontejneru SQL služby Cosmos DB string (povinné)
indexováníZásady Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v kontejneru automatické. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. To musí být zadáno pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
partitionKey Konfigurace klíče oddílu, který se má použít k rozdě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 u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

ClientEncryptionPolicy

Název Description Hodnota
includedPaths Cesty k položce, které vyžadují š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 pomocí id a klíče oddílu. int (povinné)

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

ClientEncryptionIncludedPath

Název Description 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é)
typ šifrování Typ šifrování, které se má provést. Např - deterministické, randomizované. string (povinné)
program Cesta, která musí být zašifrovaná. string (povinné)

ComputedProperty

Název Description Hodnota
name Název počítané vlastnosti, například "cp_lowerName" řetězec
query Dotaz, který vyhodnocuje hodnotu vypočítané vlastnosti, například " SELECT VALUE LOWER(c.name) FROM c" řetězec

ConflictResolutionPolicy

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

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli jsou zásady 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í. 'consistent'
"Líný"
'none' (žádný)
spatialIndexes Seznam prostorových specifik SpatialSpec[]

CompositePath

Název Description Hodnota
pořadí Pořadí řazení složených cest 'vzestupně'
'sestupně'
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

ExcludedPath

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

IncludedPath

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. 'LineString'
'MultiPolygon'
'Číslo'
"Bod"
'Mnohoúhelník'
'Řetězec'
Druhu Označuje typ indexu. 'Hash'
'Rozsah'
'Prostorový'
Přesnost Přesnost indexu. -1 je maximální přesnost. int

SpatialSpec

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec
typy Seznam prostorového typu cesty Pole řetězců obsahující některou z těchto možností:
'LineString'
'MultiPolygon'
"Bod"
'Mnohoúhelník'

MaterializedViewDefinition

Název Description Hodnota
definice Definicí by měl 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é)
id zdrojové kolekce Název zdrojového kontejneru, na kterém bude materializované zobrazení vytvořeno. string (povinné)

Klíč oddílu kontejneru

Název Description Hodnota
Druhu Označuje druh algoritmu použitého k dělení. V případě prostředí 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é data v kontejneru rozdělit na oddíly string[]
verze Označuje verzi definice klíče oddílu. int

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

ResourceRestoreParameters

Název Description Hodnota
obnovitzdroj ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
obnoveníWithTtlDisabled Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný parametr Time to Live. bool

UniqueKeyPolicy

Název Description Hodnota
jedinečné klíče Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB Jedinečný klíč[]

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být pro každý dokument ve službě Azure Cosmos DB jedinečný. string[]

Šablony pro rychlý start

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

Template (Šablona) Description
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 služby Azure Cosmos pro rozhraní Core API (SQL) s databází a kontejnerem s propustností s několika dalšími možnostmi.
Rozhraní SQL API účtu služby Azure Cosmos DB s analytickým úložištěm

Nasazení do Azure		 Tato šablona vytvoří účet služby Azure Cosmos pro rozhraní Core (SQL) API s databází a kontejnerem nakonfigurovaným s analytickým úložištěm.
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 služby Azure Cosmos pro rozhraní Core API (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í Core (SQL) API služby Azure Cosmos DB

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í.
Nasazení Azure Data Explorer DB s připojením ke službě Cosmos DB

Nasazení do Azure		 Nasazení Azure Data Explorer DB s připojením ke službě Cosmos DB

Definice prostředku Terraform (poskytovatel AzAPI)

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

  • 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-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  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"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Hodnoty vlastností

databaseAccounts/sqlDatabases/containers

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview
name Název prostředku string (povinné)
location Umístění skupiny prostředků, do které prostředek patří. řetězec
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu : sqlDatabases
tags Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupení tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč, který nesmí být delší než 128 znaků a hodnota nesmí být větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastavené na defaultExperience: Cassandra. Aktuální hodnoty defaultExperience také zahrnují "Table", "Graph", "DocumentDB" a "MongoDB". Slovník názvů a hodnot značek.
identity Identita prostředku. Identita spravované služby
properties Vlastnosti pro vytvoření a aktualizaci kontejneru Služby Azure Cosmos DB SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (povinné)

ManagedServiceIdentity

Název Description Hodnota
typ "SystemAssigned"
"SystemAssigned,UserAssigned"
UserAssigned: Typ identity použité 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.
identity_ids Seznam identit uživatelů přidružených k prostředku Odkazy na klíče slovníku identit uživatelů budou ID prostředků ARM ve formátu :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Pole ID identit uživatelů

ManagedServiceIdentityUserAssignedIdentity

Název Description Hodnota
{přizpůsobená vlastnost} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Název Description Hodnota
možnosti Dvojice možností klíč-hodnota, které se mají použít pro požadavek. To odpovídá hlavičkám odeslaným s požadavkem. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
prostředek Standardní formát JSON kontejneru SqlContainerResourceOrSqlContainerGetPropertiesResou... (povinné)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Název Description Hodnota
automatické škálováníSettings Určuje nastavení automatického škálování. Poznámka: Vyžaduje se nastavení propustnosti nebo automatického škálování, ale ne obojí. Automatické nastavení škálování
throughput Jednotky žádostí za sekundu. Například propustnost: 10000. int

Automatické nastavení škálování

Název Description Hodnota
maxThroughput Představuje maximální propustnost, na které může prostředek vertikálně navýšit kapacitu. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Název Description Hodnota
analyticalStorageTtl Hodnota TTL analýzy. 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í"
"PointInTimeRestore"
"Obnovit"
defaultTtl Výchozí hodnota time to Live int
id Název kontejneru SQL služby Cosmos DB string (povinné)
indexováníZásady Konfigurace zásad indexování. Ve výchozím nastavení je indexování pro všechny cesty k dokumentům v kontejneru automatické. IndexingPolicy
materializedViewDefinition Konfigurace pro definování materializovaných zobrazení. To musí být zadáno pouze pro vytvoření kontejneru materializovaného zobrazení. MaterializedViewDefinition
partitionKey Konfigurace klíče oddílu, který se má použít k rozdě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 u dokumentů v kolekci ve službě Azure Cosmos DB UniqueKeyPolicy

ClientEncryptionPolicy

Název Description Hodnota
includedPaths Cesty k položce, které vyžadují š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í id a cesty ke klíči oddílu. int (povinné)

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

ClientEncryptionIncludedPath

Název Description Hodnota
clientEncryptionKeyId Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty. string (povinné)
šifrováníAlgorithm Š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říklad – deterministický, randomizovaný. string (povinné)
program Cesta, která musí být zašifrovaná. string (povinné)

ComputedProperty

Název Description Hodnota
name Název vypočítané vlastnosti, například "cp_lowerName" řetězec
query Dotaz, který vyhodnocuje hodnotu vypočítané vlastnosti, například " SELECT VALUE LOWER(c.name) FROM c" řetězec

KonfliktResolutionPolicy

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

IndexingPolicy

Název Description Hodnota
automatická Označuje, jestli jsou zásady 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í. "consistent" (konzistentní)
"Líný"
"none"
spatialIndexes Seznam prostorových specifik SpatialSpec[]

CompositePath

Název Description Hodnota
pořadí Pořadí řazení složených cest "vzestupně"
"sestupně"
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

ExcludedPath

Název Description Hodnota
program Cesta, pro kterou se chování indexování vztahuje. Cesty k indexu obvykle začínají kořenem a končí zástupným znakem (/cesta/*). řetězec

Zahrnutá cesta

Název Description Hodnota
Indexy Seznam indexů pro tuto cestu Indexy[]
program Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*). řetězec

Indexy

Název Description Hodnota
dataType Datový typ, pro který je chování indexování použito. "LineString"
"MultiPolygon"
"Číslo"
"Point"
"Mnohoúhelník"
"Řetězec"
Druhu Označuje typ indexu. "Hash"
"Rozsah"
"Prostorové"
Přesnost Přesnost indexu. -1 je maximální přesnost. int

SpatialSpec

Název Description Hodnota
program Cesta, pro 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 Pole řetězců obsahující některou z těchto možností:
"LineString"
"MultiPolygon"
"Point"
"Mnohoúhelník"

MaterializedViewDefinition

Název Description Hodnota
definice Definice by měla být dotaz SQL, který by se použil k načtení dat ze zdrojového kontejneru a naplnění do kontejneru Materialized View. string (povinné)
sourceCollectionId Název zdrojového kontejneru, ve kterém se materializované zobrazení vytvoří. string (povinné)

ContainerPartitionKey

Název Description Hodnota
Druhu Označuje typ algoritmu použitého k dělení. Pro 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é dělit data v kontejneru string[]
verze Označuje verzi definice klíče oddílu. int

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

ResourceRestoreParameters

Název Description Hodnota
restoreSource ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} řetězec
restoreTimestampInUtc Čas, do kterého musí být účet obnoven (formát ISO-8601). řetězec
restoreWithTtlDisabled Určuje, jestli bude obnovený účet po úspěšném obnovení zakázaný funkce Time-to-Live. bool

UniqueKeyPolicy

Název Description Hodnota
uniqueKeys Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB. UniqueKey[]

UniqueKey

Název Description Hodnota
Cesty Seznam cest musí být jedinečný pro každý dokument ve službě Azure Cosmos DB. string[]