Database Microsoft.DocumentDBAccounts/sqlDatabases/containers 2023-04-15
- Terbaru
- Pratinjau 2024-02-15
- 2023-11-15
- Pratinjau 11-15 2023
- 2023-09-15
- Pratinjau 2023-09-15
- 2023-04-15
- 2023-03-15
- Pratinjau 2023-03-15
- Pratinjau 01-03-2023
- 2022-11-15
- Pratinjau 11-15 2022
- 2022-08-15
- 15-08-2022-pratinjau
- 2022-05-15
- 2022-05-15-pratinjau
- Pratinjau 2022-02-15
- Pratinjau 11-15 2021
- 2021-10-15
- Pratinjau 10-15 2021
- Pratinjau 01-07-2021
- 2021-06-15
- 2021-05-15
- 2021-04-15
- Pratinjau 01-04-2021
- 2021-03-15
- Pratinjau 01-03-2021
- 2021-01-15
- 2020-09-01
- 2020-06-01-pratinjau
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Definisi sumber daya Bicep
Jenis sumber daya databaseAccounts/sqlDatabases/containers dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, tambahkan Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-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'
]
}
]
}
}
}
}
Nilai properti
databaseAccounts/sqlDatabases/containers
| Nama | Deskripsi | Nilai |
|---|---|---|
| nama | Nama sumber daya Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep. |
string (diperlukan) |
| lokasi | Lokasi grup sumber daya tempat sumber daya berada. | string |
| tag | Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| induk | Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk. Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk. |
Nama simbolis untuk sumber daya jenis: sqlDatabases |
| properti | Properti untuk membuat dan memperbarui kontainer Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (diperlukan) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nama | Deskripsi | Nilai |
|---|---|---|
| opsi | Sepasang opsi kunci-nilai yang akan diterapkan untuk permintaan. Ini sesuai dengan header yang dikirim dengan permintaan. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| sumber daya | Format JSON standar kontainer | SqlContainerResourceOrSqlContainerGetPropertiesResou... (diperlukan) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nama | Deskripsi | Nilai |
|---|---|---|
| autoscaleSettings | Menentukan pengaturan Autoscale. | AutoscaleSettings |
| throughput | Unit Permintaan per detik. Misalnya, "throughput": 10000. | int |
AutoscaleSettings
| Nama | Deskripsi | Nilai |
|---|---|---|
| maxThroughput | Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nama | Deskripsi | Nilai |
|---|---|---|
| analyticalStorageTtl | TTL Analitis. | int |
| clientEncryptionPolicy | Kebijakan enkripsi klien untuk kontainer. | ClientEncryptionPolicy |
| conflictResolutionPolicy | Kebijakan penyelesaian konflik untuk kontainer. | ConflictResolutionPolicy |
| defaultTtl | Waktu hidup default | int |
| id | Nama kontainer Cosmos DB SQL | string (diperlukan) |
| indexingPolicy | Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam kontainer | IndexingPolicy |
| partitionKey | Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi | ContainerPartitionKey |
| uniqueKeyPolicy | Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| includedPaths | Jalur item yang memerlukan enkripsi bersama dengan pengaturan khusus jalur. | ClientEncryptionIncludedPath[] (wajib) |
| policyFormatVersion | Versi definisi kebijakan enkripsi klien. Versi yang didukung adalah 1 dan 2. Versi 2 mendukung enkripsi jalur kunci id dan partisi. | int (diperlukan) Batasan: Nilai min = 1 Nilai maks = 2 |
ClientEncryptionIncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| clientEncryptionKeyId | Pengidentifikasi Kunci Enkripsi Klien yang akan digunakan untuk mengenkripsi jalur. | string (diperlukan) |
| encryptionAlgorithm | Algoritma enkripsi yang akan digunakan. Misalnya - AEAD_AES_256_CBC_HMAC_SHA256. | string (diperlukan) |
| encryptionType | Jenis enkripsi yang akan dilakukan. Misalnya - Deterministik, Acak. | string (diperlukan) |
| jalur | Jalur yang perlu dienkripsi. | string (diperlukan) |
ConflictResolutionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| conflictResolutionPath | Jalur resolusi konflik dalam kasus mode LastWriterWins. | string |
| conflictResolutionProcedure | Prosedur untuk mengatasi konflik dalam kasus mode kustom. | string |
| mode | Menunjukkan mode resolusi konflik. | 'Kustom' 'LastWriterWins' |
IndexingPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| automatic | Menunjukkan apakah kebijakan pengindeksan bersifat otomatis | bool |
| compositeIndexes | Daftar daftar jalur komposit | CompositePath[] |
| excludedPaths | Daftar jalur yang akan dikecualikan dari pengindeksan | ExcludedPath[] |
| includedPaths | Daftar jalur yang akan disertakan dalam pengindeksan | IncludedPath[] |
| indexingMode | Menunjukkan mode pengindeksan. | 'konsisten' 'malas' 'none' |
| spatialIndexes | Daftar spesifikasi spasial | SpatialSpec[] |
CompositePath
| Nama | Deskripsi | Nilai |
|---|---|---|
| urutan | Urutkan urutan untuk jalur komposit. | 'Naik' 'Turun' |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
ExcludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
IncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| Indeks | Daftar indeks untuk jalur ini | Indeks[] |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
Indeks
| Nama | Deskripsi | Nilai |
|---|---|---|
| dataType | Jenis data tempat perilaku pengindeksan diterapkan. | 'LineString' 'MultiPolygon' 'Angka' 'Titik' 'Poligon' 'String' |
| jenis | Menunjukkan jenis indeks. | 'Hash' 'Rentang' 'Spasial' |
| presisi | Presisi indeks. -1 adalah presisi maksimum. | int |
SpatialSpec
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
| Jenis | Daftar jenis spasial jalur | Array string yang berisi salah satu dari: 'LineString' 'MultiPolygon' 'Titik' 'Poligon' |
ContainerPartitionKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer | 'Hash' 'MultiHash' 'Rentang' |
| jalur | Daftar jalur yang menggunakan data mana dalam kontainer yang dapat dipartisi | string[] |
| versi | Menunjukkan versi definisi kunci partisi | int Batasan: Nilai min = 1 Nilai maks = 2 |
UniqueKeyPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| uniqueKeys | Daftar kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Daftar jalur harus unik untuk setiap dokumen dalam layanan Azure Cosmos DB | string[] |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
Membuat akun Azure Cosmos DB tingkat gratis |
Templat ini membuat akun Azure Cosmos DB tingkat gratis untuk SQL API dengan database dengan throughput dan kontainer bersama. |
| Membuat akun Azure Cosmos DB untuk CORE (SQL) API |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya. |
| SQL API akun Azure Cosmos DB dengan penyimpanan analitis |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitis. |
| Membuat SQL API akun Azure Cosmos DB dengan skala otomatis |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya. |
| Membuat prosedur tersimpan API Azure Cosmos DB Core (SQL) |
Templat ini membuat akun Azure Cosmos DB untuk CORE (SQL) API dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna. |
| Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB |
Sebarkan Azure Data Explorer DB dengan koneksi Cosmos DB. |
Definisi sumber daya templat ARM
Jenis sumber daya databaseAccounts/sqlDatabases/containers dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, tambahkan JSON berikut ke templat Anda.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2023-04-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" ]
}
]
}
}
}
}
Nilai properti
databaseAccounts/sqlDatabases/containers
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
| apiVersion | Versi api sumber daya | '2023-04-15' |
| nama | Nama sumber daya Lihat cara mengatur nama dan jenis untuk sumber daya anak dalam templat JSON ARM. |
string (diperlukan) |
| lokasi | Lokasi grup sumber daya tempat sumber daya berada. | string |
| tag | Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". | Kamus nama dan nilai tag. Lihat Tag dalam templat |
| properti | Properti untuk membuat dan memperbarui kontainer Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (diperlukan) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nama | Deskripsi | Nilai |
|---|---|---|
| opsi | Sepasang opsi kunci-nilai yang akan diterapkan untuk permintaan. Ini sesuai dengan header yang dikirim dengan permintaan. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| sumber daya | Format JSON standar kontainer | SqlContainerResourceOrSqlContainerGetPropertiesResou... (diperlukan) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nama | Deskripsi | Nilai |
|---|---|---|
| autoscaleSettings | Menentukan pengaturan Autoscale. | AutoscaleSettings |
| throughput | Unit Permintaan per detik. Misalnya, "throughput": 10000. | int |
AutoscaleSettings
| Nama | Deskripsi | Nilai |
|---|---|---|
| maxThroughput | Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nama | Deskripsi | Nilai |
|---|---|---|
| analyticalStorageTtl | TTL analitis. | int |
| clientEncryptionPolicy | Kebijakan enkripsi klien untuk kontainer. | ClientEncryptionPolicy |
| conflictResolutionPolicy | Kebijakan resolusi konflik untuk kontainer. | ConflictResolutionPolicy |
| defaultTtl | Waktu hidup default | int |
| id | Nama kontainer Cosmos DB SQL | string (diperlukan) |
| indexingPolicy | Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam kontainer | IndexingPolicy |
| partitionKey | Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi | ContainerPartitionKey |
| uniqueKeyPolicy | Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| includedPaths | Jalur item yang memerlukan enkripsi bersama dengan pengaturan khusus jalur. | ClientEncryptionIncludedPath[] (diperlukan) |
| policyFormatVersion | Versi definisi kebijakan enkripsi klien. Versi yang didukung adalah 1 dan 2. Versi 2 mendukung enkripsi jalur kunci id dan partisi. | int (diperlukan) Batasan: Nilai min = 1 Nilai maks = 2 |
ClientEncryptionIncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| clientEncryptionKeyId | Pengidentifikasi Kunci Enkripsi Klien yang akan digunakan untuk mengenkripsi jalur. | string (diperlukan) |
| encryptionAlgorithm | Algoritma enkripsi yang akan digunakan. Misalnya - AEAD_AES_256_CBC_HMAC_SHA256. | string (diperlukan) |
| encryptionType | Jenis enkripsi yang akan dilakukan. Misalnya - Deterministik, Acak. | string (diperlukan) |
| jalur | Jalur yang perlu dienkripsi. | string (diperlukan) |
ConflictResolutionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| conflictResolutionPath | Jalur resolusi konflik dalam kasus mode LastWriterWins. | string |
| conflictResolutionProcedure | Prosedur untuk mengatasi konflik dalam kasus mode kustom. | string |
| mode | Menunjukkan mode resolusi konflik. | 'Kustom' 'LastWriterWins' |
IndexingPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| automatic | Menunjukkan apakah kebijakan pengindeksan bersifat otomatis | bool |
| compositeIndexes | Daftar daftar jalur komposit | CompositePath[] |
| excludedPaths | Daftar jalur yang akan dikecualikan dari pengindeksan | ExcludedPath[] |
| includedPaths | Daftar jalur yang akan disertakan dalam pengindeksan | IncludedPath[] |
| indexingMode | Menunjukkan mode pengindeksan. | 'konsisten' 'malas' 'none' |
| spatialIndexes | Daftar spesifikasi spasial | SpatialSpec[] |
CompositePath
| Nama | Deskripsi | Nilai |
|---|---|---|
| urutan | Urutkan urutan untuk jalur komposit. | 'Naik' 'Turun' |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
ExcludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
IncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| Indeks | Daftar indeks untuk jalur ini | Indeks[] |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
Indeks
| Nama | Deskripsi | Nilai |
|---|---|---|
| dataType | Jenis data tempat perilaku pengindeksan diterapkan. | 'LineString' 'MultiPolygon' 'Angka' 'Titik' 'Poligon' 'String' |
| jenis | Menunjukkan jenis indeks. | 'Hash' 'Rentang' 'Spasial' |
| presisi | Presisi indeks. -1 adalah presisi maksimum. | int |
SpatialSpec
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
| Jenis | Daftar jenis spasial jalur | Array string yang berisi salah satu dari: 'LineString' 'MultiPolygon' 'Titik' 'Poligon' |
ContainerPartitionKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer | 'Hash' 'MultiHash' 'Rentang' |
| jalur | Daftar jalur yang menggunakan data mana dalam kontainer yang dapat dipartisi | string[] |
| versi | Menunjukkan versi definisi kunci partisi | int Batasan: Nilai min = 1 Nilai maks = 2 |
UniqueKeyPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| uniqueKeys | Daftar kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Daftar jalur harus unik untuk setiap dokumen dalam layanan Azure Cosmos DB | string[] |
Templat Mulai Cepat
Templat mulai cepat berikut menyebarkan jenis sumber daya ini.
| Templat | Deskripsi |
|---|---|
| Membuat akun Azure Cosmos DB tingkat gratis |
Templat ini membuat akun Azure Cosmos DB tingkat gratis untuk SQL API dengan database dengan throughput dan kontainer bersama. |
| Membuat akun Azure Cosmos DB untuk CORE (SQL) API |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput dengan beberapa opsi lainnya. |
| SQL API akun Azure Cosmos DB dengan penyimpanan analitis |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer yang dikonfigurasi dengan penyimpanan analitis. |
| Membuat SQL API akun Azure Cosmos DB dengan skala otomatis |
Templat ini membuat akun Azure Cosmos untuk CORE (SQL) API dengan database dan kontainer dengan throughput skala otomatis dengan beberapa opsi lainnya. |
| Membuat prosedur tersimpan API Azure Cosmos DB Core (SQL) |
Templat ini membuat akun Azure Cosmos DB untuk CORE (SQL) API dan kontainer dengan prosedur tersimpan, pemicu, dan fungsi yang ditentukan pengguna. |
| Menyebarkan Azure Data Explorer DB dengan koneksi Cosmos DB |
Sebarkan Azure Data Explorer DB dengan koneksi Cosmos DB. |
Definisi sumber daya Terraform (penyedia AzAPI)
Jenis sumber daya databaseAccounts/sqlDatabases/containers dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya
Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.
Format sumber daya
Untuk membuat sumber daya Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-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"
]
}
]
}
}
}
})
}
Nilai properti
databaseAccounts/sqlDatabases/containers
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15" |
| nama | Nama sumber daya | string (diperlukan) |
| lokasi | Lokasi grup sumber daya tempat sumber daya berada. | string |
| parent_id | ID sumber daya yang merupakan induk untuk sumber daya ini. | ID untuk sumber daya jenis: sqlDatabases |
| tag | Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". | Kamus nama dan nilai tag. |
| properti | Properti untuk membuat dan memperbarui kontainer Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (diperlukan) |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| Nama | Deskripsi | Nilai |
|---|---|---|
| opsi | Sepasang opsi kunci-nilai yang akan diterapkan untuk permintaan. Ini sesuai dengan header yang dikirim dengan permintaan. | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| sumber daya | Format JSON standar kontainer | SqlContainerResourceOrSqlContainerGetPropertiesResou... (diperlukan) |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| Nama | Deskripsi | Nilai |
|---|---|---|
| autoscaleSettings | Menentukan pengaturan Autoscale. | AutoscaleSettings |
| throughput | Unit Permintaan per detik. Misalnya, "throughput": 10000. | int |
AutoscaleSettings
| Nama | Deskripsi | Nilai |
|---|---|---|
| maxThroughput | Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya. | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| Nama | Deskripsi | Nilai |
|---|---|---|
| analyticalStorageTtl | TTL analitis. | int |
| clientEncryptionPolicy | Kebijakan enkripsi klien untuk kontainer. | ClientEncryptionPolicy |
| conflictResolutionPolicy | Kebijakan resolusi konflik untuk kontainer. | ConflictResolutionPolicy |
| defaultTtl | Waktu hidup default | int |
| id | Nama kontainer Cosmos DB SQL | string (diperlukan) |
| indexingPolicy | Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam kontainer | IndexingPolicy |
| partitionKey | Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi | ContainerPartitionKey |
| uniqueKeyPolicy | Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKeyPolicy |
ClientEncryptionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| includedPaths | Jalur item yang memerlukan enkripsi bersama dengan pengaturan khusus jalur. | ClientEncryptionIncludedPath[] (wajib) |
| policyFormatVersion | Versi definisi kebijakan enkripsi klien. Versi yang didukung adalah 1 dan 2. Versi 2 mendukung enkripsi jalur kunci id dan partisi. | int (diperlukan) Batasan: Nilai min = 1 Nilai maks = 2 |
ClientEncryptionIncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| clientEncryptionKeyId | Pengidentifikasi Kunci Enkripsi Klien yang akan digunakan untuk mengenkripsi jalur. | string (diperlukan) |
| encryptionAlgorithm | Algoritma enkripsi yang akan digunakan. Misalnya - AEAD_AES_256_CBC_HMAC_SHA256. | string (diperlukan) |
| encryptionType | Jenis enkripsi yang akan dilakukan. Misalnya - Deterministik, Acak. | string (diperlukan) |
| jalur | Jalur yang perlu dienkripsi. | string (diperlukan) |
ConflictResolutionPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| conflictResolutionPath | Jalur resolusi konflik dalam kasus mode LastWriterWins. | string |
| conflictResolutionProcedure | Prosedur untuk mengatasi konflik dalam kasus mode kustom. | string |
| mode | Menunjukkan mode resolusi konflik. | "Custom" "LastWriterWins" |
IndexingPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| automatic | Menunjukkan apakah kebijakan pengindeksan bersifat otomatis | bool |
| compositeIndexes | Daftar daftar jalur komposit | CompositePath[] |
| excludedPaths | Daftar jalur yang akan dikecualikan dari pengindeksan | ExcludedPath[] |
| includedPaths | Daftar jalur yang akan disertakan dalam pengindeksan | IncludedPath[] |
| indexingMode | Menunjukkan mode pengindeksan. | "konsisten" "malas" "tidak ada" |
| spatialIndexes | Daftar spesifikasi spasial | SpatialSpec[] |
CompositePath
| Nama | Deskripsi | Nilai |
|---|---|---|
| urutan | Urutkan urutan untuk jalur komposit. | "Naik" "turun" |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhbungkan dengan wildcard (/path/*) | string |
ExcludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhbungkan dengan wildcard (/path/*) | string |
IncludedPath
| Nama | Deskripsi | Nilai |
|---|---|---|
| Indeks | Daftar indeks untuk jalur ini | Indeks[] |
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
Indeks
| Nama | Deskripsi | Nilai |
|---|---|---|
| dataType | Jenis data tempat perilaku pengindeksan diterapkan. | "LineString" "MultiPolygon" "Angka" "Titik" "Poligon" "String" |
| jenis | Menunjukkan jenis indeks. | "Hash" "Rentang" "Spasial" |
| presisi | Presisi indeks. -1 adalah presisi maksimum. | int |
SpatialSpec
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*) | string |
| Jenis | Daftar jenis spasial jalur | Array string yang berisi salah satu dari: "LineString" "MultiPolygon" "Titik" "Poligon" |
ContainerPartitionKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer | "Hash" "MultiHash" "Rentang" |
| jalur | Daftar jalur yang menggunakan data mana dalam kontainer yang dapat dipartisi | string[] |
| versi | Menunjukkan versi definisi kunci partisi | int Batasan: Nilai min = 1 Nilai maks = 2 |
UniqueKeyPolicy
| Nama | Deskripsi | Nilai |
|---|---|---|
| uniqueKeys | Daftar kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB. | UniqueKey[] |
UniqueKey
| Nama | Deskripsi | Nilai |
|---|---|---|
| jalur | Daftar jalur harus unik untuk setiap dokumen dalam layanan Azure Cosmos DB | string[] |
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk