Microsoft.DocumentDB 資料庫Accounts/apis/databases/graphs 2015-11-06
Bicep 資源定義
databaseAccounts/apis/databases/graphs 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-11-06' = {
parent: resourceSymbolicName
name: 'string'
properties: {
options: {
{customized property}: 'string'
}
resource: {
conflictResolutionPolicy: {
conflictResolutionPath: 'string'
conflictResolutionProcedure: 'string'
mode: 'string'
}
defaultTtl: int
id: 'string'
indexingPolicy: {
automatic: bool
excludedPaths: [
{
path: 'string'
}
]
includedPaths: [
{
indexes: [
{
dataType: 'string'
kind: 'string'
precision: int
}
]
path: 'string'
}
]
indexingMode: 'string'
}
partitionKey: {
kind: 'string'
paths: [
'string'
]
}
uniqueKeyPolicy: {
uniqueKeys: [
{
paths: [
'string'
]
}
]
}
}
}
}
屬性值
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 指出用於數據分割的演算法類型 | 'Hash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
CreateUpdateOptions
| 名字 | 描述 | 價值 |
|---|
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptions （必要） |
| 資源 | Gremlin 圖形的標準 JSON 格式 | GremlinGraphResource （必要） |
GremlinGraphResource
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPolicy | 圖形的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB Gremlin 圖形的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，圖表內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | '一致' '懶惰' 'None' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱：databaseAccounts/apis/databases |
| 性能 | 用來建立及更新 Azure Cosmos DB Gremlin 圖形的屬性。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties （必要） |
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |
ARM 樣本資源定義
databaseAccounts/apis/databases/graphs 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
"apiVersion": "2015-11-06",
"name": "string",
"properties": {
"options": {
"{customized property}": "string"
},
"resource": {
"conflictResolutionPolicy": {
"conflictResolutionPath": "string",
"conflictResolutionProcedure": "string",
"mode": "string"
},
"defaultTtl": "int",
"id": "string",
"indexingPolicy": {
"automatic": "bool",
"excludedPaths": [
{
"path": "string"
}
],
"includedPaths": [
{
"indexes": [
{
"dataType": "string",
"kind": "string",
"precision": "int"
}
],
"path": "string"
}
],
"indexingMode": "string"
},
"partitionKey": {
"kind": "string",
"paths": [ "string" ]
},
"uniqueKeyPolicy": {
"uniqueKeys": [
{
"paths": [ "string" ]
}
]
}
}
}
}
屬性值
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 指出用於數據分割的演算法類型 | 'Hash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
CreateUpdateOptions
| 名字 | 描述 | 價值 |
|---|
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptions （必要） |
| 資源 | Gremlin 圖形的標準 JSON 格式 | GremlinGraphResource （必要） |
GremlinGraphResource
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPolicy | 圖形的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB Gremlin 圖形的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，圖表內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | '一致' '懶惰' 'None' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2015-11-06' |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 用來建立及更新 Azure Cosmos DB Gremlin 圖形的屬性。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties （必要） |
| 類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs' |
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |
Terraform （AzAPI 提供者） 資源定義
databaseAccounts/apis/databases/graphs 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-11-06"
name = "string"
body = jsonencode({
properties = {
options = {
{customized property} = "string"
}
resource = {
conflictResolutionPolicy = {
conflictResolutionPath = "string"
conflictResolutionProcedure = "string"
mode = "string"
}
defaultTtl = int
id = "string"
indexingPolicy = {
automatic = bool
excludedPaths = [
{
path = "string"
}
]
includedPaths = [
{
indexes = [
{
dataType = "string"
kind = "string"
precision = int
}
]
path = "string"
}
]
indexingMode = "string"
}
partitionKey = {
kind = "string"
paths = [
"string"
]
}
uniqueKeyPolicy = {
uniqueKeys = [
{
paths = [
"string"
]
}
]
}
}
}
})
}
屬性值
ConflictResolutionPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPath | LastWriterWins 模式的衝突解決路徑。 | 字串 |
| conflictResolutionProcedure | 解決自定義模式衝突的程式。 | 字串 |
| 模式 | 表示衝突解決模式。 | 'Custom' 'LastWriterWins' |
ContainerPartitionKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 類 | 指出用於數據分割的演算法類型 | 'Hash' 'Range' |
| 路徑 | 使用容器內可分割數據的路徑清單 | string[] |
CreateUpdateOptions
| 名字 | 描述 | 價值 |
|---|
ExcludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptions （必要） |
| 資源 | Gremlin 圖形的標準 JSON 格式 | GremlinGraphResource （必要） |
GremlinGraphResource
| 名字 | 描述 | 價值 |
|---|---|---|
| conflictResolutionPolicy | 圖形的衝突解決原則。 | ConflictResolutionPolicy |
| defaultTtl | 默認存留時間 | int |
| id | Cosmos DB Gremlin 圖形的名稱 | 字串 （必要） |
| indexingPolicy | 編製索引原則的組態。 根據預設，圖表內所有文件路徑的索引會自動編製索引 | IndexingPolicy |
| partitionKey | 分割區索引鍵的組態，用於將數據分割成多個分割區 | ContainerPartitionKey |
| uniqueKeyPolicy | 針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 | UniqueKeyPolicy |
IncludedPath
| 名字 | 描述 | 價值 |
|---|---|---|
| 指標 | 此路徑的索引清單 | 索引[] |
| 路徑 | 索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 （/path/*） | 字串 |
指標
| 名字 | 描述 | 價值 |
|---|---|---|
| dataType | 套用索引行為的數據類型。 | 'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String' |
| 類 | 表示索引的類型。 | 'Hash' 'Range' 'Spatial' |
| 精度 | 索引的有效位數。 -1 是最大精確度。 | int |
IndexingPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| 自動 | 指出索引編製原則是否為自動 | bool |
| excludedPaths | 要從索引編製中排除的路徑清單 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路徑清單 | IncludedPath[] |
| indexingMode | 表示索引模式。 | '一致' '懶惰' 'None' |
Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼：databaseAccounts/apis/databases |
| 性能 | 用來建立及更新 Azure Cosmos DB Gremlin 圖形的屬性。 | GremlinGraphCreateUpdatePropertiesOrGremlinGraphProperties （必要） |
| 類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2015-11-06” |
UniqueKey
| 名字 | 描述 | 價值 |
|---|---|---|
| 路徑 | Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 | string[] |
UniqueKeyPolicy
| 名字 | 描述 | 價值 |
|---|---|---|
| uniqueKeys | 上唯一索引鍵的清單，該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 | UniqueKey[] |