Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/containers
- 最新
- 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-預覽版
- 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
Bicep 資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
clientEncryptionPolicy: {
includedPaths: [
{
clientEncryptionKeyId: 'string'
encryptionAlgorithm: 'string'
encryptionType: 'string'
path: 'string'
}
]
policyFormatVersion: int
}
computedProperties: [
{
name: 'string'
query: 'string'
}
]
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
createMode: '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'
]
}
]
}
materializedViewDefinition: {
definition: 'string'
sourceCollectionId: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
version: int
}
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
屬性值
databaseAccounts/sqlDatabases/containers
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
需要字串 () |
| location | 資源所屬之資源群組的位置。 | 字串 |
| tags | 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： sqlDatabases |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 用來建立和更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... 必要 () |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名稱 | 描述 | 值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| clientEncryptionPolicy | 容器的用戶端加密原則。 | ClientEncryptionPolicy |
| computedProperties | 計算屬性的清單 | ComputedProperty[] |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| createMode | 表示資源建立模式的列舉。 | 'Default' 'PointInTimeRestore' 'Restore' |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 字串 (必要) |
| indexingPolicy | 索引編製原則的組態。 根據預設，容器內的所有文件路徑都會自動編製索引 | IndexingPolicy |
| materializedViewDefinition | 定義具體化檢視的組態。 這隻能指定為建立具體化檢視容器。 | MaterializedViewDefinition |
| partitionKey | 分割區索引鍵的設定，用於將數據分割成多個分割區 | ContainerPartitionKey |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
| uniqueKeyPolicy | 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則設定。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| includedPaths | 需要加密的項目路徑以及路徑特定設定。 | ClientEncryptionIncludedPath[] (必要) |
| policyFormatVersion | 用戶端加密原則定義的版本。 支援的版本為 1 和 2。 第 2 版支援識別碼和分割區金鑰路徑加密。 | int (必要) 約束： 最小值 = 1 最大值 = 2 |
ClientEncryptionIncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| clientEncryptionKeyId | 用來加密路徑之用戶端加密金鑰的識別碼。 | 字串 (必要) |
| encryptionAlgorithm | 將使用的加密演算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。 | 字串 (必要) |
| encryptionType | 要執行的加密類型。 例如 - 具決定性、隨機化。 | 字串 (必要) |
| path | 需要加密的路徑。 | 字串 (必要) |
ComputedProperty
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 計算屬性的名稱，例如 - “cp_lowerName” | 字串 |
| 查詢 | 評估計算屬性值的查詢，例如 - “SELECT VALUE LOWER (c.name) FROM c” | 字串 |
ConflictResolutionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| mode | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
IndexingPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| automatic | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單的清單 | CompositePath[] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引編製模式。 | '一致' 'lazy' 'none' |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
CompositePath
| 名稱 | 描述 | 值 |
|---|---|---|
| 順序 | 複合路徑的排序順序。 | 'ascending' 'descending' |
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
ExcludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
IncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| 索引 | 此路徑的索引清單 | Indexes[] |
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
索引
| 名稱 | 描述 | 值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| kind | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精確度 | 索引的有效位數。 -1 是最大精確度。 | int |
SpatialSpec
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
| types | 路徑的空間類型清單 | 包含任何項目的字串數組： 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
MaterializedViewDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 定義 | 定義應該是 SQL 查詢，用來從來源容器擷取數據，以填入具體化檢視容器。 | 字串 (必要) |
| sourceCollectionId | 要在其中建立具體化檢視的來源容器名稱。 | 字串 (必要) |
ContainerPartitionKey
| 名稱 | 描述 | 值 |
|---|---|---|
| kind | 指出用於數據分割的演算法種類。 針對 MultiHash，容器建立最多支援三個最大) (多個分割區索引鍵 | 'Hash' 'MultiHash' 'Range' |
| 路徑 | 用來分割容器內數據的路徑清單 | string[] |
| version | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
UniqueKeyPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| uniqueKeys | 在上強制執行 Azure Cosmos DB 服務集合中檔的唯一性條件約束的唯一索引鍵清單。 | UniqueKey[] |
UniqueKey
| 名稱 | 描述 | 值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單都必須是唯一的 | string[] |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立免費層的 Azure Cosmos DB 帳戶 |
此範本會使用具有共用輸送量和容器的資料庫，建立 SQL API 的免費層 Azure Cosmos DB 帳戶。 |
| 建立 Core (SQL) API 的 Azure Cosmos DB 帳戶 |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項之輸送量的資料庫和容器。 |
| Azure Cosmos DB 帳戶 SQL API 與分析存放區 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含使用分析存放區設定的資料庫和容器。 |
| 使用自動調整建立 Azure Cosmos DB 帳戶 SQL API |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有資料庫和容器以及具有多個其他選項的自動調整輸送量容器。 |
| 建立 Azure Cosmos DB Core (SQL) API 預存程式 |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
| 使用 Cosmos DB 連線部署 Azure Data Explorer DB |
使用 Cosmos DB 連線部署 Azure Data Explorer DB。 |
ARM 範本資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"clientEncryptionPolicy": {
"includedPaths": [
{
"clientEncryptionKeyId": "string",
"encryptionAlgorithm": "string",
"encryptionType": "string",
"path": "string"
}
],
"policyFormatVersion": "int"
},
"computedProperties": [
{
"name": "string",
"query": "string"
}
],
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"createMode": "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" ]
}
]
},
"materializedViewDefinition": {
"definition": "string",
"sourceCollectionId": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ],
"version": "int"
},
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
屬性值
databaseAccounts/sqlDatabases/containers
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
| apiVersion | 資源 API 版本 | '2024-02-15-preview' |
| NAME | 資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
需要字串 () |
| location | 資源所屬之資源群組的位置。 | 字串 |
| tags | 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 用來建立和更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... 必要 () |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加為 。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名稱 | 描述 | 值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| clientEncryptionPolicy | 容器的用戶端加密原則。 | ClientEncryptionPolicy |
| computedProperties | 計算屬性的清單 | ComputedProperty[] |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| createMode | 列舉，表示資源建立模式。 | 'Default' 'PointInTimeRestore' 'Restore' |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 需要字串 () |
| indexingPolicy | 編製索引原則的組態。 根據預設，容器內的所有文件路徑都會自動編製索引 | IndexingPolicy |
| materializedViewDefinition | 定義具體化檢視的組態。 這隻能指定為建立具體化檢視容器。 | MaterializedViewDefinition |
| partitionKey | 分割區索引鍵的設定，用於將數據分割成多個分割區 | ContainerPartitionKey |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
| uniqueKeyPolicy | 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| includedPaths | 需要加密的項目路徑以及路徑特定設定。 | ClientEncryptionIncludedPath[] (必要) |
| policyFormatVersion | 用戶端加密原則定義的版本。 支援的版本為 1 和 2。 第 2 版支援識別碼和分割區金鑰路徑加密。 | 需要 int () 約束： 最小值 = 1 最大值 = 2 |
ClientEncryptionIncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| clientEncryptionKeyId | 用來加密路徑之用戶端加密金鑰的識別碼。 | 需要字串 () |
| encryptionAlgorithm | 將使用的加密演算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。 | 需要字串 () |
| encryptionType | 要執行的加密類型。 例如 - 確定性、隨機化。 | 需要字串 () |
| path | 需要加密的路徑。 | 需要字串 () |
ComputedProperty
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 計算屬性的名稱，例如 - “cp_lowerName” | 字串 |
| 查詢 | 評估計算屬性值的查詢，例如 - “SELECT VALUE LOWER (c.name) FROM c” | 字串 |
ConflictResolutionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| mode | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
IndexingPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| automatic | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單的清單 | CompositePath[] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引編製模式。 | '一致' 'lazy' 'none' |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
CompositePath
| 名稱 | 描述 | 值 |
|---|---|---|
| 順序 | 複合路徑的排序順序。 | 'ascending' 'descending' |
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
ExcludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
IncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| 索引 | 此路徑的索引清單 | Indexes[] |
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
索引
| 名稱 | 描述 | 值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| kind | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精確度 | 索引的有效位數。 -1 是最大精確度。 | int |
SpatialSpec
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
| types | 路徑的空間類型清單 | 包含任何項目的字串數組： 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
MaterializedViewDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 定義 | 定義應該是 SQL 查詢，用來從來源容器擷取數據，以填入具體化檢視容器。 | 字串 (必要) |
| sourceCollectionId | 要在其中建立具體化檢視的來源容器名稱。 | 字串 (必要) |
ContainerPartitionKey
| 名稱 | 描述 | 值 |
|---|---|---|
| kind | 指出用於數據分割的演算法種類。 針對 MultiHash，容器建立最多支援三個最大) (多個分割區索引鍵 | 'Hash' 'MultiHash' 'Range' |
| 路徑 | 用來分割容器內數據的路徑清單 | string[] |
| version | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
UniqueKeyPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| uniqueKeys | 在上強制執行 Azure Cosmos DB 服務集合中檔的唯一性條件約束的唯一索引鍵清單。 | UniqueKey[] |
UniqueKey
| 名稱 | 描述 | 值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單都必須是唯一的 | string[] |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 建立免費層的 Azure Cosmos DB 帳戶 |
此範本會使用具有共用輸送量和容器的資料庫，建立 SQL API 的免費層 Azure Cosmos DB 帳戶。 |
| 建立 Core (SQL) API 的 Azure Cosmos DB 帳戶 |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有多個其他選項之輸送量的資料庫和容器。 |
| Azure Cosmos DB 帳戶 SQL API 與分析存放區 |
此範本會建立 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含使用分析存放區設定的資料庫和容器。 |
| 使用自動調整建立 Azure Cosmos DB 帳戶 SQL API |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos 帳戶，其中包含具有資料庫和容器以及具有多個其他選項的自動調整輸送量容器。 |
| 建立 Azure Cosmos DB Core (SQL) API 預存程式 |
此範本會建立適用於 Core (SQL) API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
| 使用 Cosmos DB 連線部署 Azure Data Explorer DB |
使用 Cosmos DB 連線部署 Azure Data Explorer DB。 |
Terraform (AzAPI 提供者) 資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
clientEncryptionPolicy = {
includedPaths = [
{
clientEncryptionKeyId = "string"
encryptionAlgorithm = "string"
encryptionType = "string"
path = "string"
}
]
policyFormatVersion = int
}
computedProperties = [
{
name = "string"
query = "string"
}
]
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
createMode = "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"
]
}
]
}
materializedViewDefinition = {
definition = "string"
sourceCollectionId = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
version = int
}
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
屬性值
databaseAccounts/sqlDatabases/containers
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview” |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源所屬資源群組的位置。 | 字串 |
| parent_id | 此資源之父系的資源標識碼。 | 類型的資源標識碼： sqlDatabases |
| tags | 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 用來建立和更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”：用於資源的身分識別類型。 類型 「SystemAssigned，UserAssigned」 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 「None」 會從服務中移除任何身分識別。 |
|
| identity_ids | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 使用者身分識別標識碼的陣列。 |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...
| 名稱 | 描述 | 值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOption... |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResou... 必要 () |
CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
AutoscaleSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加為 。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名稱 | 描述 | 值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| clientEncryptionPolicy | 容器的用戶端加密原則。 | ClientEncryptionPolicy |
| computedProperties | 計算屬性的清單 | ComputedProperty[] |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| createMode | 列舉，表示資源建立模式。 | “預設值” “PointInTimeRestore” “還原” |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 需要字串 () |
| indexingPolicy | 編製索引原則的組態。 根據預設，容器內的所有文件路徑都會自動編製索引 | IndexingPolicy |
| materializedViewDefinition | 定義具體化檢視的組態。 這隻能指定為建立具體化檢視容器。 | MaterializedViewDefinition |
| partitionKey | 分割區索引鍵的設定，用於將數據分割成多個分割區 | ContainerPartitionKey |
| restoreParameters | 用來指出還原相關信息的參數 | ResourceRestoreParameters |
| uniqueKeyPolicy | 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
ClientEncryptionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| includedPaths | 需要加密的項目路徑以及路徑特定設定。 | ClientEncryptionIncludedPath[] (必要) |
| policyFormatVersion | 用戶端加密原則定義的版本。 支援的版本為 1 和 2。 第 2 版支援識別碼和分割區金鑰路徑加密。 | int (必要) 約束： 最小值 = 1 最大值 = 2 |
ClientEncryptionIncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| clientEncryptionKeyId | 用來加密路徑之用戶端加密金鑰的識別碼。 | 字串 (必要) |
| encryptionAlgorithm | 將使用的加密演算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。 | 字串 (必要) |
| encryptionType | 要執行的加密類型。 例如 - 具決定性、隨機化。 | 字串 (必要) |
| path | 需要加密的路徑。 | 字串 (必要) |
ComputedProperty
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 計算屬性的名稱，例如 - “cp_lowerName” | 字串 |
| 查詢 | 評估計算屬性值的查詢，例如 - “SELECT VALUE LOWER (c.name) FROM c” | 字串 |
ConflictResolutionPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| mode | 表示衝突解決模式。 | "Custom" “LastWriterWins” |
IndexingPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| automatic | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單的清單 | CompositePath[] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引編製模式。 | “一致” “lazy” “none” |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
CompositePath
| 名稱 | 描述 | 值 |
|---|---|---|
| 順序 | 複合路徑的排序順序。 | “ascending” “descending” |
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
ExcludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
IncludedPath
| 名稱 | 描述 | 值 |
|---|---|---|
| 索引 | 此路徑的索引清單 | Indexes[] |
| path | 套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
索引
| 名稱 | 描述 | 值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | “LineString” “MultiPolygon” “數位” “Point” 多邊形” “String” |
| kind | 表示索引的類型。 | “Hash” “Range” “空間” |
| 精確度 | 索引的有效位數。 -1 是最大精確度。 | int |
SpatialSpec
| 名稱 | 描述 | 值 |
|---|---|---|
| path | 套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*) | 字串 |
| types | 路徑的空間類型清單 | 包含任何項目的字串數組： “LineString” “MultiPolygon” “Point” 多邊形” |
MaterializedViewDefinition
| 名稱 | 描述 | 值 |
|---|---|---|
| 定義 | 定義應該是 SQL 查詢，用來從來源容器擷取數據，以填入具體化檢視容器。 | 需要字串 () |
| sourceCollectionId | 要在其中建立具體化檢視的來源容器名稱。 | 需要字串 () |
ContainerPartitionKey
| 名稱 | 描述 | 值 |
|---|---|---|
| kind | 指出用於數據分割的演算法種類。 針對 MultiHash，容器建立最多支援最多三個) (多個分割區索引鍵 | “Hash” “MultiHash” “Range” |
| 路徑 | 可分割容器內數據的路徑清單 | string[] |
| version | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
ResourceRestoreParameters
| 名稱 | 描述 | 值 |
|---|---|---|
| restoreSource | 必須起始還原之可還原資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 字串 |
| restoreTimestampInUtc | 帳戶必須還原的時間 (ISO-8601 格式) 。 | 字串 |
| restoreWithTtlDisabled | 指定還原的帳戶是否在成功還原時停用存留時間。 | bool |
UniqueKeyPolicy
| 名稱 | 描述 | 值 |
|---|---|---|
| uniqueKeys | 上的唯一索引鍵清單，會針對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |
UniqueKey
| 名稱 | 描述 | 值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單都必須是唯一的 | string[] |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應