Dela via

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2019-08-01

  • Artikel

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@2019-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      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

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

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure 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

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptions

Namn Beskrivning Värde

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes 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"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Namn Beskrivning Värde
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

SpatialSpec

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. CreateUpdateOptions (krävs)
resurs JSON-standardformatet för en container SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för containern. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namnet på Cosmos DB SQL-containern sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

Taggar

Namn Beskrivning Värde

UniqueKey

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

UniqueKeyPolicy

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

Snabbstartsexempel

Följande snabbstartsexempel distribuerar 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": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "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

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

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure 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

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptions

Namn Beskrivning Värde

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes 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"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Namn Beskrivning Värde
apiVersion API-versionen '2019-08-01'
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"

SpatialSpec

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. CreateUpdateOptions (krävs)
resurs JSON-standardformatet för en container SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för containern. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namnet på Cosmos DB SQL-containern sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

Taggar

Namn Beskrivning Värde

UniqueKey

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

UniqueKeyPolicy

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
SQL API för Azure Cosmos DB-konto med analysarkiv

Distribuera till Azure 		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å

Distribuera till Azure 		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

Distribuera till Azure 		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

Distribuera till Azure 		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)

Distribuera till Azure 		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

Distribuera till Azure 		Skapa en Dapr-mikrotjänstapp med containerappar.
Skapar en Dapr pub-sub servicebus-app med containerappar

Distribuera till Azure 		Skapa en Dapr pub-sub servicebus-app med containerappar.
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning

Distribuera till Azure 		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:

  • Resursgrupper

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@2019-08-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        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

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

ConflictResolutionPolicy

Namn Beskrivning Värde
conflictResolutionPath Konfliktlösningssökvägen när det gäller LastWriterWins-läge. sträng
conflictResolutionProcedure 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

Namn Beskrivning Värde
sort Anger vilken typ av algoritm som används för partitionering "Hash"
"Intervall"
Sökvägar Lista över sökvägar som använder vilka data i containern som kan partitioneras string[]
version Anger versionen av partitionsnyckeldefinitionen Int

Begränsningar:
Minsta värde = 1
Maxvärde = 2

CreateUpdateOptions

Namn Beskrivning Värde

ExcludedPath

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

IncludedPath

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

IndexingPolicy

Namn Beskrivning Värde
automatisk Anger om indexeringsprincipen är automatisk Bool
compositeIndexes 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"
spatialIndexes Lista över rumsliga detaljer SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Namn Beskrivning Värde
plats Platsen för den resursgrupp som resursen tillhör. sträng
Namn Resursnamnet sträng (krävs)
parent_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@2019-08-01"

SpatialSpec

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. CreateUpdateOptions (krävs)
resurs JSON-standardformatet för en container SqlContainerResourceOrSqlContainerGetPropertiesResource (krävs)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Namn Beskrivning Värde
conflictResolutionPolicy Konfliktlösningsprincipen för containern. ConflictResolutionPolicy
defaultTtl Standardtid till live Int
Id Namnet på Cosmos DB SQL-containern sträng (krävs)
indexingPolicy Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern IndexingPolicy
partitionKey Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner ContainerPartitionKey
uniqueKeyPolicy Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. UniqueKeyPolicy

Taggar

Namn Beskrivning Värde

UniqueKey

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

UniqueKeyPolicy

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