Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
- senaste
- 2025-05-01-förhandsversion
- 2025-04-15
- 2024-12-01-förhandsversion
- 2024-11-15
- 2024-09-01 – förhandsversion
- 2024-08-15
- 2024-05-15
- 2024-05-15 – förhandsversion
- 2024-02-15 – förhandsversion
- 2023-11-15
- 2023-11-15 – förhandsversion
- 2023-09-15
- 2023-09-15 för hands version
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01 – förhandsversion
- 2022-11-15
- Förhandsversion av 2022-11-15
- 2022-08-15
- 2022-08-15 för hands hands version
- 2022-05-15
- 2022-05-15 – preview
- 2022-02-15 för hands
- 2021-11-15 – förhandsversion
- 2021-10-15
- 2021-10-15-preview
- Förhandsversion 2021-07-01
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- Förhandsversion 2021-03-01
- 2021-01-15
- 2020-09-01
- Förhandsversion 2020-06-01
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-resursdefinition
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: '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'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}
Egenskapsvärden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde | 
|---|---|---|
| identitet | Identitet för resursen. | ManagedServiceIdentity (HanteradServiceIdentitet) | 
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng | 
| Namn | Resursnamnet | sträng (krävs) | 
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. | Symboliskt namn för resurs av typen: databaseAccounts/sqlDatabases | 
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) | 
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar | 
AutoskalningInställningar
| Namn | Beskrivning | Värde | 
|---|---|---|
| max-genomströmning | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int | 
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde | 
|---|
CompositePath
| Namn | Beskrivning | Värde | 
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Konfliktlösningspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng | 
| konfliktLösningProcedur | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng | 
| läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" | 
ContainerPartitionKey (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| sort | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" | 
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | sträng[] | 
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 | 
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde | 
|---|---|---|
| autoscaleSettings (autoskalning) | Anger inställningarna för autoskalning. | AutoskalningInställningar | 
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int | 
ExcludedPath (Utesluten)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
InkluderadSökväg
| Namn | Beskrivning | Värde | 
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Index
| Namn | Beskrivning | Värde | 
|---|---|---|
| Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" | 
| sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" | 
| precision | Indexets precision. -1 är maximal precision. | Int | 
Indexeringspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| automatisk | Anger om indexeringsprincipen är automatisk | Bool | 
| compositeIndex | Lista över lista över sammansatta sökvägar | CompositePath[][] | 
| excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] | 
| includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] | 
| indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" | 
| spatialIndex | Lista över rumsliga detaljer | SpatialSpec[] | 
ManagedServiceIdentity (HanteradServiceIdentitet)
| Namn | Beskrivning | Värde | 
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" | 
| användartilldelade identiteter | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter | 
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde | 
|---|
SpatialSpec (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" | 
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Namn | Beskrivning | Värde | 
|---|---|---|
| Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions | 
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) | 
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde | 
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int | 
| conflictResolutionPolicy (på engelska) | Konfliktlösningsprincipen för containern. | Konfliktlösningspolicy | 
| defaultTtl (standard)Ttl | Standardtid till live | Int | 
| Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) | 
| Princip för indexering | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | Princip för indexering | 
| partitionKey (på engelska) | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey (på engelska) | 
| uniqueKeyPolicy (på engelska) | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy (på engelska) | 
Taggar
| Namn | Beskrivning | Värde | 
|---|
UniqueKey (Unik nyckel)
| Namn | Beskrivning | Värde | 
|---|---|---|
| Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | sträng[] | 
UniqueKeyPolicy (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] | 
Användningsexempel
Azure-snabbstartsexempel
Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.
| Bicep-fil | Beskrivning | 
|---|---|
| SQL API för Azure Cosmos DB-konto med analysarkiv | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet. | 
| Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå | Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container. | 
| Skapa ett Azure Cosmos DB-konto för Core (SQL) API | Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ. | 
| Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ. | 
| Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL) | Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion. | 
| Skapar en Dapr-mikrotjänstapp med containerappar | Skapa en Dapr-mikrotjänstapp med containerappar. | 
| Skapar en Dapr pub-sub servicebus-app med containerappar | Skapa en Dapr pub-sub servicebus-app med containerappar. | 
| Distribuera Azure Data Explorer DB med Cosmos DB-anslutning | Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. | 
Resursdefinition för ARM-mall
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande JSON i mallen.
{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2021-11-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "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" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}
Egenskapsvärden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde | 
|---|---|---|
| apiVersion | API-versionen | "2021-11-15-preview" | 
| identitet | Identitet för resursen. | ManagedServiceIdentity (HanteradServiceIdentitet) | 
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng | 
| Namn | Resursnamnet | sträng (krävs) | 
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) | 
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar | 
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" | 
AutoskalningInställningar
| Namn | Beskrivning | Värde | 
|---|---|---|
| max-genomströmning | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int | 
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde | 
|---|
CompositePath
| Namn | Beskrivning | Värde | 
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Konfliktlösningspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng | 
| konfliktLösningProcedur | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng | 
| läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" | 
ContainerPartitionKey (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| sort | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" | 
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | sträng[] | 
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 | 
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde | 
|---|---|---|
| autoscaleSettings (autoskalning) | Anger inställningarna för autoskalning. | AutoskalningInställningar | 
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int | 
ExcludedPath (Utesluten)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
InkluderadSökväg
| Namn | Beskrivning | Värde | 
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Index
| Namn | Beskrivning | Värde | 
|---|---|---|
| Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" | 
| sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" | 
| precision | Indexets precision. -1 är maximal precision. | Int | 
Indexeringspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| automatisk | Anger om indexeringsprincipen är automatisk | Bool | 
| compositeIndex | Lista över lista över sammansatta sökvägar | CompositePath[][] | 
| excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] | 
| includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] | 
| indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" | 
| spatialIndex | Lista över rumsliga detaljer | SpatialSpec[] | 
ManagedServiceIdentity (HanteradServiceIdentitet)
| Namn | Beskrivning | Värde | 
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" | 
| användartilldelade identiteter | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter | 
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde | 
|---|
SpatialSpec (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" | 
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Namn | Beskrivning | Värde | 
|---|---|---|
| Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions | 
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) | 
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde | 
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int | 
| conflictResolutionPolicy (på engelska) | Konfliktlösningsprincipen för containern. | Konfliktlösningspolicy | 
| defaultTtl (standard)Ttl | Standardtid till live | Int | 
| Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) | 
| Princip för indexering | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | Princip för indexering | 
| partitionKey (på engelska) | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey (på engelska) | 
| uniqueKeyPolicy (på engelska) | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy (på engelska) | 
Taggar
| Namn | Beskrivning | Värde | 
|---|
UniqueKey (Unik nyckel)
| Namn | Beskrivning | Värde | 
|---|---|---|
| Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | sträng[] | 
UniqueKeyPolicy (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] | 
Användningsexempel
Azure-snabbstartsmallar
Följande Azure-snabbstartsmallar distribuera den här resurstypen.
| Mall | Beskrivning | 
|---|---|
| SQL API för Azure Cosmos DB-konto med analysarkiv | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet. | 
| Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå | Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container. | 
| Skapa ett Azure Cosmos DB-konto för Core (SQL) API | Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ. | 
| Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning | Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ. | 
| Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL) | Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion. | 
| Skapar en Dapr-mikrotjänstapp med containerappar | Skapa en Dapr-mikrotjänstapp med containerappar. | 
| Skapar en Dapr pub-sub servicebus-app med containerappar | Skapa en Dapr pub-sub servicebus-app med containerappar. | 
| Distribuera Azure Data Explorer DB med Cosmos DB-anslutning | Distribuera Azure Data Explorer DB med Cosmos DB-anslutning. | 
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "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"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  }
}
Egenskapsvärden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Namn | Beskrivning | Värde | 
|---|---|---|
| identitet | Identitet för resursen. | ManagedServiceIdentity (HanteradServiceIdentitet) | 
| plats | Platsen för den resursgrupp som resursen tillhör. | sträng | 
| Namn | Resursnamnet | sträng (krävs) | 
| föräldra_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: databaseAccounts/sqlDatabases | 
| Egenskaper | Egenskaper för att skapa och uppdatera Azure Cosmos DB-container. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (krävs) | 
| Taggar | Resurstaggar | Ordlista med taggnamn och värden. | 
| typ | Resurstypen | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview" | 
AutoskalningInställningar
| Namn | Beskrivning | Värde | 
|---|---|---|
| max-genomströmning | Representerar maximalt dataflöde, resursen kan skalas upp till. | Int | 
Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Namn | Beskrivning | Värde | 
|---|
CompositePath
| Namn | Beskrivning | Värde | 
|---|---|---|
| ordning | Sorteringsordning för sammansatta sökvägar. | "stigande" "fallande" | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Konfliktlösningspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| conflictResolutionPath | Konfliktlösningssökvägen när det gäller LastWriterWins-läge. | sträng | 
| konfliktLösningProcedur | Proceduren för att lösa konflikter när det gäller anpassat läge. | sträng | 
| läge | Anger konfliktlösningsläget. | "Anpassad" "LastWriterWins" | 
ContainerPartitionKey (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| sort | Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande | "Hash" "MultiHash" "Intervall" | 
| Sökvägar | Lista över sökvägar som använder vilka data i containern som kan partitioneras | sträng[] | 
| version | Anger versionen av partitionsnyckeldefinitionen | Int Begränsningar: Minsta värde = 1 Maxvärde = 2 | 
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Namn | Beskrivning | Värde | 
|---|---|---|
| autoscaleSettings (autoskalning) | Anger inställningarna för autoskalning. | AutoskalningInställningar | 
| genomströmning | Enheter för begäranden per sekund. Till exempel "dataflöde": 10000. | Int | 
ExcludedPath (Utesluten)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
InkluderadSökväg
| Namn | Beskrivning | Värde | 
|---|---|---|
| Index | Lista över index för den här sökvägen | Index[] | 
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
Index
| Namn | Beskrivning | Värde | 
|---|---|---|
| Datatyp | Den datatyp som indexeringsbeteendet tillämpas på. | "LineString" "MultiPolygon" "Tal" "Punkt" "Polygon" "Sträng" | 
| sort | Anger typen av index. | "Hash" "Intervall" "Rumslig" | 
| precision | Indexets precision. -1 är maximal precision. | Int | 
Indexeringspolicy
| Namn | Beskrivning | Värde | 
|---|---|---|
| automatisk | Anger om indexeringsprincipen är automatisk | Bool | 
| compositeIndex | Lista över lista över sammansatta sökvägar | CompositePath[][] | 
| excludedPaths | Lista över sökvägar som ska undantas från indexering | ExcludedPath[] | 
| includedPaths | Lista över sökvägar som ska inkluderas i indexeringen | IncludedPath[] | 
| indexingMode | Anger indexeringsläget. | "konsekvent" "lat" "ingen" | 
| spatialIndex | Lista över rumsliga detaljer | SpatialSpec[] | 
ManagedServiceIdentity (HanteradServiceIdentitet)
| Namn | Beskrivning | Värde | 
|---|---|---|
| typ | Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. | "Ingen" "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" | 
| användartilldelade identiteter | Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentiteter | 
ManagedServiceIdentityUserAssignedIdentiteter
| Namn | Beskrivning | Värde | 
|---|
SpatialSpec (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| stig | Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) | sträng | 
| Typer | Lista över sökvägens rumsliga typ | Strängmatris som innehåller något av: "LineString" "MultiPolygon" "Punkt" "Polygon" | 
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Namn | Beskrivning | Värde | 
|---|---|---|
| Alternativ | Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions | 
| resurs | JSON-standardformatet för en container | SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs) | 
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Namn | Beskrivning | Värde | 
|---|---|---|
| analyticalStorageTtl | TTL för analys. | Int | 
| conflictResolutionPolicy (på engelska) | Konfliktlösningsprincipen för containern. | Konfliktlösningspolicy | 
| defaultTtl (standard)Ttl | Standardtid till live | Int | 
| Id | Namnet på Cosmos DB SQL-containern | sträng (krävs) | 
| Princip för indexering | Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern | Princip för indexering | 
| partitionKey (på engelska) | Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner | ContainerPartitionKey (på engelska) | 
| uniqueKeyPolicy (på engelska) | Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKeyPolicy (på engelska) | 
Taggar
| Namn | Beskrivning | Värde | 
|---|
UniqueKey (Unik nyckel)
| Namn | Beskrivning | Värde | 
|---|---|---|
| Sökvägar | Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten | sträng[] | 
UniqueKeyPolicy (på engelska)
| Namn | Beskrivning | Värde | 
|---|---|---|
| uniqueKeys | Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. | UniqueKey[] | 
Användningsexempel
Terraform-exempel
Ett grundläggande exempel på hur du distribuerar SQL Container i ett Cosmos DB-konto.
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    = ["*"]
}