Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/containers 2021-11-15-preview
- 最新
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 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
Bicep 資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview' = {
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: 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'
}
}
屬性值
AutoscaleSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加至 。 | int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 價值 |
|---|
CompositePath
| 名字 | 描述 | 價值 |
|---|---|---|
| 次序 | 複合路徑的排序順序。 | 'ascending' 'descending' |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 表示用於數據分割的演算法類型。 針對 MultiHash，容器建立支援多個分割區索引鍵 （最多三個最大值） | 'Hash' 'MultiHash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
| 版本 | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單清單 | CompositePath[][] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | 'consistent' '懶惰' 'none' |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 資源的身分識別。 | ManagedServiceIdentity |
| 位置 | 資源所屬資源群組的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱：databaseAccounts/sqlDatabases |
| 性能 | 用來建立及更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
SpatialSpec
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
| 類型 | 路徑的空間類型清單 | 包含任何的字串數組： 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResource （必要） |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| 名字 | 描述 | 價值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，容器內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
標籤
| 名字 | 描述 | 價值 |
|---|
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 使用分析存放區 Azure Cosmos DB 帳戶 SQL API | 此範本會建立適用於 Core （SQL） API 的 Azure Cosmos 帳戶，其中包含使用分析存放區設定的資料庫和容器。 |
| 建立免費層 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 Core （SQL） API 預存程式 | 此範本會建立適用於 Core （SQL） API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
| 使用 Container Apps 建立 Dapr 微服務應用程式 | 使用 Container Apps 建立 Dapr 微服務應用程式。 |
| 使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式 | 使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式。 |
| 使用 Cosmos DB 連線部署 Azure 數據總管 DB | 使用 Cosmos DB 連線部署 Azure 數據總管 DB。 |
ARM 樣本資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2021-11-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "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"
}
}
屬性值
AutoscaleSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加至 。 | int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 價值 |
|---|
CompositePath
| 名字 | 描述 | 價值 |
|---|---|---|
| 次序 | 複合路徑的排序順序。 | 'ascending' 'descending' |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 表示用於數據分割的演算法類型。 針對 MultiHash，容器建立支援多個分割區索引鍵 （最多三個最大值） | 'Hash' 'MultiHash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
| 版本 | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單清單 | CompositePath[][] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | 'consistent' '懶惰' 'none' |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2021-11-15-preview' |
| 身份 | 資源的身分識別。 | ManagedServiceIdentity |
| 位置 | 資源所屬資源群組的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 用來建立及更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
SpatialSpec
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
| 類型 | 路徑的空間類型清單 | 包含任何的字串數組： 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResource （必要） |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| 名字 | 描述 | 價值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，容器內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
標籤
| 名字 | 描述 | 價值 |
|---|
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
使用分析存放區 Azure Cosmos DB 帳戶 SQL API
|
此範本會建立適用於 Core （SQL） API 的 Azure Cosmos 帳戶，其中包含使用分析存放區設定的資料庫和容器。 |
|
建立免費層 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 Core （SQL） API 預存程式
|
此範本會建立適用於 Core （SQL） API 的 Azure Cosmos DB 帳戶，以及具有預存程式、觸發程式和使用者定義函式的容器。 |
|
使用 Container Apps 建立 Dapr 微服務應用程式
|
使用 Container Apps 建立 Dapr 微服務應用程式。 |
|
使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式
|
使用 Container Apps 建立 Dapr pub-sub servicebus 應用程式。 |
|
使用 Cosmos DB 連線部署 Azure 數據總管 DB
|
使用 Cosmos DB 連線部署 Azure 數據總管 DB。 |
Terraform （AzAPI 提供者） 資源定義
databaseAccounts/sqlDatabases/containers 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = 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"
]
}
]
}
}
}
})
}
屬性值
AutoscaleSettings
| 名字 | 描述 | 價值 |
|---|---|---|
| maxThroughput | 代表最大輸送量，資源可以相應增加至 。 | int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| 名字 | 描述 | 價值 |
|---|
CompositePath
| 名字 | 描述 | 價值 |
|---|---|---|
| 次序 | 複合路徑的排序順序。 | 'ascending' 'descending' |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 表示用於數據分割的演算法類型。 針對 MultiHash，容器建立支援多個分割區索引鍵 （最多三個最大值） | 'Hash' 'MultiHash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
| 版本 | 指出分割區索引鍵定義的版本 | int 約束： 最小值 = 1 最大值 = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| autoscaleSettings | 指定自動調整設定。 | AutoscaleSettings |
| 輸送量 | 每秒要求單位數。 例如，「輸送量」：10000。 | int |
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| compositeIndexes | 複合路徑清單清單 | CompositePath[][] |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | 'consistent' '懶惰' 'none' |
| spatialIndexes | 空間特定項目清單 | SpatialSpec[] |
ManagedServiceIdentity
| 名字 | 描述 | 價值 |
|---|---|---|
| 類型 | 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned' |
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名字 | 描述 | 價值 |
|---|
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| 名字 | 描述 | 價值 |
|---|---|---|
| 身份 | 資源的身分識別。 | ManagedServiceIdentity |
| 位置 | 資源所屬資源群組的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼：databaseAccounts/sqlDatabases |
| 性能 | 用來建立及更新 Azure Cosmos DB 容器的屬性。 | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-11-15-preview” |
SpatialSpec
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
| 類型 | 路徑的空間類型清單 | 包含任何的字串數組： 'LineString' 'MultiPolygon' 'Point' 'Polygon' |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions |
| 資源 | 容器的標準 JSON 格式 | SqlContainerResourceOrSqlContainerGetPropertiesResource （必要） |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| 名字 | 描述 | 價值 |
|---|---|---|
| 分析StorageTtl | 分析TTL。 | int |
| conflictResolutionPolicy | 容器的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB SQL 容器的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，容器內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
標籤
| 名字 | 描述 | 價值 |
|---|
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |