Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2023-09-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlDatabases/containers można wdrożyć przy użyciu operacji docelowych:

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/sqlDatabases/containers, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: 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'
  }
}

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

ClientEncryptionIncludedPath

Nazwa Opis Wartość
clientEncryptionKeyId Identyfikator klucza szyfrowania klienta, który ma być używany do szyfrowania ścieżki. ciąg (wymagany)
encryptionAlgorithm Algorytm szyfrowania, który będzie używany. Na przykład — AEAD_AES_256_CBC_HMAC_SHA256. ciąg (wymagany)
encryptionType Typ szyfrowania do wykonania. Na przykład — deterministyczne, randomizowane. ciąg (wymagany)
ścieżka Ścieżka, która musi być zaszyfrowana. ciąg (wymagany)

ClientEncryptionPolicy

Nazwa Opis Wartość
includedPaths Ścieżki elementu, który wymaga szyfrowania wraz z ustawieniami specyficznymi dla ścieżki. ClientEncryptionIncludedPath[] (wymagane)
policyFormatVersion Wersja definicji zasad szyfrowania klienta. Obsługiwane wersje to 1 i 2. Wersja 2 obsługuje szyfrowanie ścieżki identyfikatora i klucza partycji. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2 (wymagane)

Ścieżka złożona

Nazwa Opis Wartość
porządek Kolejność sortowania dla ścieżek złożonych. "rosnąco"
"malejąco"
ś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

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. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera "Skrót"
"MultiHash"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]
Wersja Wskazuje wersję definicji klucza partycji Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

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
indeksy złożone Lista listy ścieżek złożonych CompositePath[][]
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "spójne"
"leniwy"
"brak"
spatialIndexes Lista specyfiki przestrzennej SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
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/sqlDatabases
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

SpatialSpec

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
Typy Lista typu przestrzennego ścieżki Tablica ciągów zawierająca dowolną z:
"LineString"
"MultiPolygon"
"Punkt"
"Wielokąt"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
clientEncryptionPolicy Zasady szyfrowania klienta dla kontenera. ClientEncryptionPolicy
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

Tagi

Nazwa Opis Wartość

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

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym.
Tworzenie konta usługi Azure Cosmos DB w warstwie bezpłatna Ten szablon tworzy bezpłatne konto usługi Azure Cosmos DB dla interfejsu API SQL z bazą danych z udostępnioną przepływnością i kontenerem.
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Core (SQL) Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością z wieloma innymi opcjami.
Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością autoskalowania z wieloma innymi opcjami.
tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL) Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika.
Tworzy aplikację mikrousług dapr przy użyciu usługi Container Apps Tworzenie aplikacji mikrousług dapr przy użyciu usługi Container Apps.
Tworzy aplikację dapr pub-sub servicebus przy użyciu usługi Container Apps Utwórz aplikację Dapr pub-sub servicebus przy użyciu usługi Container Apps.
wdrażanie usługi Azure Data Explorer DB przy użyciu połączenia usługi Cosmos DB Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/sqlDatabases/containers można wdrożyć przy użyciu operacji docelowych:

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/sqlDatabases/containers, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2023-09-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "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"
  }
}

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

ClientEncryptionIncludedPath

Nazwa Opis Wartość
clientEncryptionKeyId Identyfikator klucza szyfrowania klienta, który ma być używany do szyfrowania ścieżki. ciąg (wymagany)
encryptionAlgorithm Algorytm szyfrowania, który będzie używany. Na przykład — AEAD_AES_256_CBC_HMAC_SHA256. ciąg (wymagany)
encryptionType Typ szyfrowania do wykonania. Na przykład — deterministyczne, randomizowane. ciąg (wymagany)
ścieżka Ścieżka, która musi być zaszyfrowana. ciąg (wymagany)

ClientEncryptionPolicy

Nazwa Opis Wartość
includedPaths Ścieżki elementu, który wymaga szyfrowania wraz z ustawieniami specyficznymi dla ścieżki. ClientEncryptionIncludedPath[] (wymagane)
policyFormatVersion Wersja definicji zasad szyfrowania klienta. Obsługiwane wersje to 1 i 2. Wersja 2 obsługuje szyfrowanie ścieżki identyfikatora i klucza partycji. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2 (wymagane)

Ścieżka złożona

Nazwa Opis Wartość
porządek Kolejność sortowania dla ścieżek złożonych. "rosnąco"
"malejąco"
ś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

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. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera "Skrót"
"MultiHash"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]
Wersja Wskazuje wersję definicji klucza partycji Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

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
indeksy złożone Lista listy ścieżek złożonych CompositePath[][]
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "spójne"
"leniwy"
"brak"
spatialIndexes Lista specyfiki przestrzennej SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-09-15'
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers"

SpatialSpec

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
Typy Lista typu przestrzennego ścieżki Tablica ciągów zawierająca dowolną z:
"LineString"
"MultiPolygon"
"Punkt"
"Wielokąt"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
clientEncryptionPolicy Zasady szyfrowania klienta dla kontenera. ClientEncryptionPolicy
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

Tagi

Nazwa Opis Wartość

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
interfejs API SQL konta usługi Azure Cosmos DB z magazynem analitycznym

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem skonfigurowanym z magazynem analitycznym.
Tworzenie konta usługi Azure Cosmos DB w warstwie bezpłatna

wdrażanie w usłudze Azure		 Ten szablon tworzy bezpłatne konto usługi Azure Cosmos DB dla interfejsu API SQL z bazą danych z udostępnioną przepływnością i kontenerem.
Tworzenie konta usługi Azure Cosmos DB dla interfejsu API Core (SQL)

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością z wieloma innymi opcjami.
Tworzenie interfejsu API SQL konta usługi Azure Cosmos DB przy użyciu autoskalowania

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos dla interfejsu API Core (SQL) z bazą danych i kontenerem z przepływnością autoskalowania z wieloma innymi opcjami.
tworzenie procedur składowanych interfejsu API Azure Cosmos DB Core (SQL)

wdrażanie w usłudze Azure		 Ten szablon tworzy konto usługi Azure Cosmos DB dla interfejsu API Core (SQL) i kontener z procedurą składowaną, wyzwalaczem i funkcją zdefiniowaną przez użytkownika.
Tworzy aplikację mikrousług dapr przy użyciu usługi Container Apps

wdrażanie w usłudze Azure		 Tworzenie aplikacji mikrousług dapr przy użyciu usługi Container Apps.
Tworzy aplikację dapr pub-sub servicebus przy użyciu usługi Container Apps

wdrażanie w usłudze Azure		 Utwórz aplikację Dapr pub-sub servicebus przy użyciu usługi Container Apps.
wdrażanie usługi Azure Data Explorer DB przy użyciu połączenia usługi Cosmos DB

wdrażanie w usłudze Azure		 Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlDatabases/containers można wdrożyć przy użyciu operacji docelowych:

  • 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/sqlDatabases/containers, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = 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"
              ]
            }
          ]
        }
      }
    }
  })
}

Wartości właściwości

AutoskalowanieUstawienia

Nazwa Opis Wartość
maxThroughput Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. Int

ClientEncryptionIncludedPath

Nazwa Opis Wartość
clientEncryptionKeyId Identyfikator klucza szyfrowania klienta, który ma być używany do szyfrowania ścieżki. ciąg (wymagany)
encryptionAlgorithm Algorytm szyfrowania, który będzie używany. Na przykład — AEAD_AES_256_CBC_HMAC_SHA256. ciąg (wymagany)
encryptionType Typ szyfrowania do wykonania. Na przykład — deterministyczne, randomizowane. ciąg (wymagany)
ścieżka Ścieżka, która musi być zaszyfrowana. ciąg (wymagany)

ClientEncryptionPolicy

Nazwa Opis Wartość
includedPaths Ścieżki elementu, który wymaga szyfrowania wraz z ustawieniami specyficznymi dla ścieżki. ClientEncryptionIncludedPath[] (wymagane)
policyFormatVersion Wersja definicji zasad szyfrowania klienta. Obsługiwane wersje to 1 i 2. Wersja 2 obsługuje szyfrowanie ścieżki identyfikatora i klucza partycji. Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2 (wymagane)

Ścieżka złożona

Nazwa Opis Wartość
porządek Kolejność sortowania dla ścieżek złożonych. "rosnąco"
"malejąco"
ś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

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. W przypadku funkcji MultiHash obsługa wielu kluczy partycji (maksymalnie trzech) jest obsługiwanych w przypadku tworzenia kontenera "Skrót"
"MultiHash"
"Zakres"
Ścieżki Lista ścieżek, w których można partycjonować dane w kontenerze string[]
Wersja Wskazuje wersję definicji klucza partycji Int

Ograniczenia:
Minimalna wartość = 1
Wartość maksymalna = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nazwa Opis Wartość
autoskalowanieUstawienia Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. AutoskalowanieUstawienia
przepustowość Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. Int

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
indeksy złożone Lista listy ścieżek złożonych CompositePath[][]
excludedPaths Lista ścieżek do wykluczenia z indeksowania ExcludedPath[]
includedPaths Lista ścieżek do uwzględnienia w indeksowaniu IncludedPath[]
indexingMode Wskazuje tryb indeksowania. "spójne"
"leniwy"
"brak"
spatialIndexes Lista specyfiki przestrzennej SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/sqlDatabases
Właściwości Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15"

SpatialSpec

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
Typy Lista typu przestrzennego ścieżki Tablica ciągów zawierająca dowolną z:
"LineString"
"MultiPolygon"
"Punkt"
"Wielokąt"

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nazwa Opis Wartość
analyticalStorageTtl Analityczny czas wygaśnięcia. Int
clientEncryptionPolicy Zasady szyfrowania klienta dla kontenera. ClientEncryptionPolicy
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

Tagi

Nazwa Opis Wartość

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