Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/apis/databases/containers

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/apis/databases/containers można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Wartości właściwości

ConflictResolutionPolicy

Nazwa Opis Wartość
conflictResolutionPath Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. struna
conflictResolutionProcedure Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. struna
tryb Wskazuje tryb rozwiązywania konfliktów. "Niestandardowy"
"LastWriterWins"

ContainerPartitionKey

Nazwa Opis Wartość
rodzaj Wskazuje rodzaj algorytmu używanego do partycjonowania "Skrót"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]

CreateUpdateOptions

Nazwa Opis Wartość

ExcludedPath

Nazwa Opis Wartość
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Uwzględniona ścieżka

Nazwa Opis Wartość
Indeksy Lista indeksów dla tej ścieżki indeksy[]
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Indeksy

Nazwa Opis Wartość
Datatype Typ danych, dla którego zastosowano zachowanie indeksowania. "LineString"
"MultiPolygon"
"Liczba"
"Punkt"
"Wielokąt"
"Ciąg"
rodzaj Wskazuje typ indeksu. "Skrót"
"Zakres"
"Przestrzenny"
precyzja Precyzja indeksu. -1 jest maksymalną precyzją. Int

IndexingPolicy

Nazwa Opis Wartość
Automatyczne Wskazuje, czy zasady indeksowania są automatyczne Bool
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "Spójny"
"Leniwy"
"Brak"

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts/apis/databases
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (wymagane)

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. createUpdateOptions (wymagane)
zasób Standardowy format JSON kontenera SqlContainerResource (wymagane)

SqlContainerResource

Nazwa Opis Wartość
conflictResolutionPolicy Zasady rozwiązywania konfliktów dla kontenera. ConflictResolutionPolicy
defaultTtl Domyślny czas wygaśnięcia Int
id Nazwa kontenera SQL usługi Cosmos DB ciąg (wymagany)
indexingPolicy Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w kontenerze IndexingPolicy
partitionKey Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji ContainerPartitionKey
uniqueKeyPolicy Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKeyPolicy

UniqueKey

Nazwa Opis Wartość
Ścieżki Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB string[]

UniqueKeyPolicy

Nazwa Opis Wartość
uniqueKeys Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKey[]

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/apis/databases/containers można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2016-03-31",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Wartości właściwości

ConflictResolutionPolicy

Nazwa Opis Wartość
conflictResolutionPath Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. struna
conflictResolutionProcedure Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. struna
tryb Wskazuje tryb rozwiązywania konfliktów. "Niestandardowy"
"LastWriterWins"

ContainerPartitionKey

Nazwa Opis Wartość
rodzaj Wskazuje rodzaj algorytmu używanego do partycjonowania "Skrót"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]

CreateUpdateOptions

Nazwa Opis Wartość

ExcludedPath

Nazwa Opis Wartość
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Uwzględniona ścieżka

Nazwa Opis Wartość
Indeksy Lista indeksów dla tej ścieżki indeksy[]
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Indeksy

Nazwa Opis Wartość
Datatype Typ danych, dla którego zastosowano zachowanie indeksowania. "LineString"
"MultiPolygon"
"Liczba"
"Punkt"
"Wielokąt"
"Ciąg"
rodzaj Wskazuje typ indeksu. "Skrót"
"Zakres"
"Przestrzenny"
precyzja Precyzja indeksu. -1 jest maksymalną precyzją. Int

IndexingPolicy

Nazwa Opis Wartość
Automatyczne Wskazuje, czy zasady indeksowania są automatyczne Bool
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "Spójny"
"Leniwy"
"Brak"

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2016-03-31'
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. createUpdateOptions (wymagane)
zasób Standardowy format JSON kontenera SqlContainerResource (wymagane)

SqlContainerResource

Nazwa Opis Wartość
conflictResolutionPolicy Zasady rozwiązywania konfliktów dla kontenera. ConflictResolutionPolicy
defaultTtl Domyślny czas wygaśnięcia Int
id Nazwa kontenera SQL usługi Cosmos DB ciąg (wymagany)
indexingPolicy Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w kontenerze IndexingPolicy
partitionKey Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji ContainerPartitionKey
uniqueKeyPolicy Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKeyPolicy

UniqueKey

Nazwa Opis Wartość
Ścieżki Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB string[]

UniqueKeyPolicy

Nazwa Opis Wartość
uniqueKeys Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKey[]

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
tworzenie usługi Azure Cosmos przy użyciu interfejsu API SQL i wielu kontenerów

wdrażanie w usłudze Azure		 Szablon tworzy kontener usługi Cosmos za pomocą interfejsu API SQL i umożliwia dodawanie kontenerów mulitple.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/apis/databases/containers można wdrożyć z operacjami docelowymi:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/apis/databases/containers, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Wartości właściwości

ConflictResolutionPolicy

Nazwa Opis Wartość
conflictResolutionPath Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. struna
conflictResolutionProcedure Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. struna
tryb Wskazuje tryb rozwiązywania konfliktów. "Niestandardowy"
"LastWriterWins"

ContainerPartitionKey

Nazwa Opis Wartość
rodzaj Wskazuje rodzaj algorytmu używanego do partycjonowania "Skrót"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]

CreateUpdateOptions

Nazwa Opis Wartość

ExcludedPath

Nazwa Opis Wartość
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Uwzględniona ścieżka

Nazwa Opis Wartość
Indeksy Lista indeksów dla tej ścieżki indeksy[]
ścieżka Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zwykle zaczynają się od katalogu głównego i kończą się symbolem wieloznacznymi (/ścieżka/*) struna

Indeksy

Nazwa Opis Wartość
Datatype Typ danych, dla którego zastosowano zachowanie indeksowania. "LineString"
"MultiPolygon"
"Liczba"
"Punkt"
"Wielokąt"
"Ciąg"
rodzaj Wskazuje typ indeksu. "Skrót"
"Zakres"
"Przestrzenny"
precyzja Precyzja indeksu. -1 jest maksymalną precyzją. Int

IndexingPolicy

Nazwa Opis Wartość
Automatyczne Wskazuje, czy zasady indeksowania są automatyczne Bool
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "Spójny"
"Leniwy"
"Brak"

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/apis/databases
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (wymagane)
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

Nazwa Opis Wartość
Opcje Para klucz-wartość opcji, które mają zostać zastosowane do żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. createUpdateOptions (wymagane)
zasób Standardowy format JSON kontenera SqlContainerResource (wymagane)

SqlContainerResource

Nazwa Opis Wartość
conflictResolutionPolicy Zasady rozwiązywania konfliktów dla kontenera. ConflictResolutionPolicy
defaultTtl Domyślny czas wygaśnięcia Int
id Nazwa kontenera SQL usługi Cosmos DB ciąg (wymagany)
indexingPolicy Konfiguracja zasad indeksowania. Domyślnie indeksowanie jest automatyczne dla wszystkich ścieżek dokumentów w kontenerze IndexingPolicy
partitionKey Konfiguracja klucza partycji, który ma być używany do partycjonowania danych na wiele partycji ContainerPartitionKey
uniqueKeyPolicy Unikatowa konfiguracja zasad klucza służący do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKeyPolicy

UniqueKey

Nazwa Opis Wartość
Ścieżki Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB string[]

UniqueKeyPolicy

Nazwa Opis Wartość
uniqueKeys Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. UniqueKey[]