Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2023-09-15
- Najnowsza
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definicja zasobu Bicep
Typ zasobu databaseAccounts/sqlDatabases/containers można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
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
databaseAccounts/sqlDatabases/containers
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| 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 : sqlDatabases |
| properties | Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (wymagane) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| zasób | Standardowy format JSON kontenera | SqlContainerResourceOrSqlContainerGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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 |
| identyfikator | 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 do użycia do partycjonowania danych na wiele partycji | ContainerPartitionKey |
| uniqueKeyPolicy | Unikatowa konfiguracja zasad klucza do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKeyPolicy |
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 (wymagane) Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
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. Np. — AEAD_AES_256_CBC_HMAC_SHA256. | ciąg (wymagany) |
| encryptionType | Typ szyfrowania do wykonania. Np. deterministyczne, losowe. | ciąg (wymagany) |
| path | Ścieżka, która musi być zaszyfrowana. | ciąg (wymagany) |
ConflictResolutionPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
| conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
| tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
IndexingPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
| compositeIndexes | 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 przestrzennych | SpatialSpec[] |
CompositePath
| Nazwa | Opis | Wartość |
|---|---|---|
| kolejność | Kolejność sortowania dla ścieżek złożonych. | "Rosnąco" "Malejąco" |
| path | Ś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 (/path/*) | ciąg |
ExcludedPath
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ś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 (/path/*) | ciąg |
IncludedPath
| Nazwa | Opis | Wartość |
|---|---|---|
| Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
| path | Ś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 (/path/*) | ciąg |
Indeksy
| Nazwa | Opis | Wartość |
|---|---|---|
| dataType | Typ danych, do którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
| Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
| precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
SpatialSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ś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 (/path/*) | ciąg |
| types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash w przypadku tworzenia kontenera jest obsługiwanych wiele kluczy partycji (maksymalnie trzy) | "Skrót" "MultiHash" "Zakres" |
| Ścieżki | Lista ścieżek, w których można partycjonować dane w kontenerze | ciąg[] |
| Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
UniqueKeyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| uniqueKeys | Lista unikatowych kluczy wymuszających ograniczenie unikatowości dla dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
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. |
| 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 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 Core (SQL) usługi Azure Cosmos DB |
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. |
| Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB |
Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB. |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/sqlDatabases/containers można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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
databaseAccounts/sqlDatabases/containers
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" |
| apiVersion | Wersja interfejsu API zasobów | '2023-09-15' |
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON. |
ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| properties | Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (wymagane) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| zasób | Standardowy format JSON kontenera | SqlContainerResourceOrSqlContainerGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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 |
| identyfikator | 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 |
ClientEncryptionPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| includedPaths | Ścieżki elementu, które wymagają 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 (wymagane) Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
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 — deterministyczny, losowy. | ciąg (wymagany) |
| path | Ścieżka, która musi być zaszyfrowana. | ciąg (wymagany) |
ConflictResolutionPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
| conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
| tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowy" "LastWriterWins" |
IndexingPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
| compositeIndexes | 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 przestrzennych | SpatialSpec[] |
CompositePath
| Nazwa | Opis | Wartość |
|---|---|---|
| kolejność | Kolejność sortowania dla ścieżek złożonych. | "Rosnąco" "malejąco" |
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Wykluczona ścieżka
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Uwzględniona ścieżka
| Nazwa | Opis | Wartość |
|---|---|---|
| Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Indeksy
| Nazwa | Opis | Wartość |
|---|---|---|
| dataType | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
| Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
| precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
SpatialSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
| types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash wiele kluczy partycji (maksymalnie trzy) jest obsługiwanych w przypadku tworzenia kontenerów | "Skrót" "MultiHash" "Zakres" |
| Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
| Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
UniqueKeyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości w dokumentach w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Template | Opis |
|---|---|
| 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. |
| 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 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 Core (SQL) usługi Azure Cosmos DB |
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. |
| Wdrażanie bazy danych usługi Azure Data Explorer przy użyciu połączenia usługi Cosmos DB |
Wdrażanie usługi Azure Data Explorer DB za pomocą połączenia usługi Cosmos DB. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/sqlDatabases/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 dziennik 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"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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
databaseAccounts/sqlDatabases/containers
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-09-15" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu : sqlDatabases |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. |
| properties | Właściwości do tworzenia i aktualizowania kontenera usługi Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (wymagane) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| opcje | Para klucz-wartość opcji do zastosowania dla żądania. Odpowiada to nagłówkom wysyłanym z żądaniem. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| zasób | Standardowy format JSON kontenera | SqlContainerResourceOrSqlContainerGetPropertiesResou... (wymagane) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nazwa | Opis | Wartość |
|---|---|---|
| autoskalowanieUstawienia | Określa ustawienia autoskalu. Uwaga: wymagana jest przepływność lub autoskalowanieUstawienia, ale nie obie. | AutoskalowanieUstawienia |
| danych | Liczba jednostek żądania na sekundę. Na przykład "przepływność": 10000. | int |
AutoskalowanieUstawienia
| Nazwa | Opis | Wartość |
|---|---|---|
| maxThroughput | Reprezentuje maksymalną przepływność, zasób może być skalowany w górę. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 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 |
| identyfikator | 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 do użycia do partycjonowania danych na wiele partycji | ContainerPartitionKey |
| uniqueKeyPolicy | Unikatowa konfiguracja zasad klucza do określania ograniczeń unikatowości dokumentów w kolekcji w usłudze Azure Cosmos DB. | UniqueKeyPolicy |
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 (wymagane) Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
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. Np. — AEAD_AES_256_CBC_HMAC_SHA256. | ciąg (wymagany) |
| encryptionType | Typ szyfrowania do wykonania. Np. deterministyczne, losowe. | ciąg (wymagany) |
| path | Ścieżka, która musi być zaszyfrowana. | ciąg (wymagany) |
ConflictResolutionPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| conflictResolutionPath | Ścieżka rozwiązywania konfliktów w przypadku trybu LastWriterWins. | ciąg |
| conflictResolutionProcedure | Procedura rozwiązywania konfliktów w przypadku trybu niestandardowego. | ciąg |
| tryb | Wskazuje tryb rozwiązywania konfliktów. | "Niestandardowe" "LastWriterWins" |
IndexingPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| automatyczne | Wskazuje, czy zasady indeksowania są automatyczne | bool |
| compositeIndexes | 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" "none" |
| spatialIndexes | Lista specyfiki przestrzennej | SpatialSpec[] |
CompositePath
| Nazwa | Opis | Wartość |
|---|---|---|
| kolejność | Kolejność sortowania dla ścieżek złożonych. | "rosnąco" "malejąco" |
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Wykluczona ścieżka
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Uwzględniona ścieżka
| Nazwa | Opis | Wartość |
|---|---|---|
| Indeksy | Lista indeksów dla tej ścieżki | Indeksy[] |
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
Indeksy
| Nazwa | Opis | Wartość |
|---|---|---|
| dataType | Typ danych, dla którego zastosowano zachowanie indeksowania. | "LineString" "MultiPolygon" "Liczba" "Punkt" "Wielokąt" "Ciąg" |
| Rodzaju | Wskazuje typ indeksu. | "Skrót" "Zakres" "Przestrzenny" |
| precision | Precyzja indeksu. -1 to maksymalna precyzja. | int |
SpatialSpec
| Nazwa | Opis | Wartość |
|---|---|---|
| path | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zazwyczaj zaczynają się od katalogu głównego i kończą się symbolami wieloznacznymi (/path/*) | ciąg |
| types (typy) | Lista typu przestrzennego ścieżki | Tablica ciągów zawierająca dowolną z: "LineString" "MultiPolygon" "Punkt" "Wielokąt" |
ContainerPartitionKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Rodzaju | Wskazuje rodzaj algorytmu używanego do partycjonowania. W przypadku funkcji MultiHash wiele kluczy partycji (maksymalnie trzy) jest obsługiwanych w przypadku tworzenia kontenerów | "Skrót" "MultiHash" "Zakres" |
| Ścieżki | Lista ścieżek, przy użyciu których dane w kontenerze mogą być partycjonowane | ciąg[] |
| Wersja | Wskazuje wersję definicji klucza partycji | int Ograniczenia: Minimalna wartość = 1 Maksymalna wartość = 2 |
UniqueKeyPolicy
| Nazwa | Opis | Wartość |
|---|---|---|
| uniqueKeys | Lista unikatowych kluczy, które wymusza ograniczenie unikatowości w dokumentach w kolekcji w usłudze Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nazwa | Opis | Wartość |
|---|---|---|
| Ścieżki | Lista ścieżek musi być unikatowa dla każdego dokumentu w usłudze Azure Cosmos DB | ciąg[] |