Udostępnij przez

Microsoft.DocumentDB databaseAccounts/apis/databases/containers

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
nadrzędny 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)

Zasady rozwiązywania konfliktów

Nazwa Opis Wartość
conflictResolutionPath (ścieżka konfliktu) Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. ciąg
conflictResolutionProcedure (procedura rozstrzygania) Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. ciąg
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 ciąg znakowy[]

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

Wykluczona ścieżka

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/*) ciąg

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/*) ciąg

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

PolitykaIndeksowania

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

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

Unikalny klucz

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

UniqueKeyPolicy

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

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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) 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"

Zasady rozwiązywania konfliktów

Nazwa Opis Wartość
conflictResolutionPath (ścieżka konfliktu) Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. ciąg
conflictResolutionProcedure (procedura rozstrzygania) Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. ciąg
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 ciąg znakowy[]

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

Wykluczona ścieżka

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/*) ciąg

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/*) ciąg

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

PolitykaIndeksowania

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

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

Unikalny klucz

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

UniqueKeyPolicy

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

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć 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:

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"
  parent_id = "string"
  body = {
    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

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id (identyfikator rodzica) 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"

Zasady rozwiązywania konfliktów

Nazwa Opis Wartość
conflictResolutionPath (ścieżka konfliktu) Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. ciąg
conflictResolutionProcedure (procedura rozstrzygania) Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. ciąg
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 ciąg znakowy[]

CreateUpdateOptions (CreateUpdateOptions)

Nazwa Opis Wartość

Wykluczona ścieżka

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/*) ciąg

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/*) ciąg

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

PolitykaIndeksowania

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

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

Unikalny klucz

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

UniqueKeyPolicy

Nazwa Opis Wartość
uniqueKeys (unikatoweKlucze) Lista unikatowych kluczy, które wymusza ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. Unikalny klucz[]
  • Last updated on