Microsoft.DocumentDB 資料庫Accounts/apis/databases/graphs

• 最新
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Bicep 資源定義

databaseAccounts/apis/databases/graphs 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
            ]
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/apis/databases/graphs

名稱	描述	值
NAME	資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。	字串 (必要)
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型資源的符號名稱： 資料庫
properties	用來建立及更新 Azure Cosmos DB Gremlin 圖形的屬性。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	Gremlin 圖形的標準 JSON 格式	需要 GremlinGraphResource ()

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

GremlinGraphResource

名稱	描述	值
conflictResolutionPolicy	圖表的衝突解決原則。	ConflictResolutionPolicy
defaultTtl	默認存留時間	int
id	Cosmos DB Gremlin 圖形的名稱	字串 (必要)
indexingPolicy	索引編製原則的組態。 根據預設，圖表內所有文件路徑的索引編製會自動	IndexingPolicy
partitionKey	分割區索引鍵的設定，用於將數據分割成多個分割區	ContainerPartitionKey
uniqueKeyPolicy	在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則設定。	UniqueKeyPolicy

ConflictResolutionPolicy

名稱	描述	值
conflictResolutionPath	LastWriterWins 模式的衝突解決路徑。	字串
conflictResolutionProcedure	解決自定義模式衝突的程式。	字串
mode	表示衝突解決模式。	'Custom' 'LastWriterWins'

IndexingPolicy

名稱	描述	值
automatic	指出索引編製原則是否為自動	bool
excludedPaths	要從索引編製中排除的路徑清單	ExcludedPath[]
includedPaths	要包含在索引中的路徑清單	IncludedPath[]
indexingMode	表示索引模式。	'一致' 'Lazy' 'None'

ExcludedPath

名稱	描述	值
path	套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

IncludedPath

名稱	描述	值
索引	此路徑的索引清單	Indexes[]
path	套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

索引

名稱	描述	值
dataType	套用索引行為的數據類型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	表示索引的類型。	'Hash' 'Range' 'Spatial'
精確度	索引的有效位數。 -1 是最大精確度。	int

ContainerPartitionKey

名稱	描述	值
kind	指出用於數據分割的演算法種類	'Hash' 'Range'
路徑	可分割容器內數據的路徑清單	string[]

UniqueKeyPolicy

名稱	描述	值
uniqueKeys	上的唯一索引鍵清單，會針對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。	UniqueKey[]

UniqueKey

名稱	描述	值
路徑	Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的	string[]

ARM 範本資源定義

databaseAccounts/apis/databases/graphs 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs",
  "apiVersion": "2016-03-31",
  "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" ]
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/apis/databases/graphs

名稱	描述	值
類型	資源類型	'Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs'
apiVersion	資源 API 版本	'2016-03-31'
NAME	資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。	需要字串 ()
properties	用來建立和更新 Azure Cosmos DB Gremlin 圖形的屬性。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	Gremlin 圖形的標準 JSON 格式	需要 GremlinGraphResource ()

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

GremlinGraphResource

名稱	描述	值
conflictResolutionPolicy	圖形的衝突解決原則。	ConflictResolutionPolicy
defaultTtl	默認存留時間	int
id	Cosmos DB Gremlin 圖形的名稱	需要字串 ()
indexingPolicy	編製索引原則的組態。 根據預設，圖表內的所有文件路徑都會自動編製索引	IndexingPolicy
partitionKey	分割區索引鍵的設定，用於將數據分割成多個分割區	ContainerPartitionKey
uniqueKeyPolicy	在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則組態。	UniqueKeyPolicy

ConflictResolutionPolicy

名稱	描述	值
conflictResolutionPath	LastWriterWins 模式的衝突解決路徑。	字串
conflictResolutionProcedure	解決自定義模式衝突的程式。	字串
mode	表示衝突解決模式。	'Custom' 'LastWriterWins'

IndexingPolicy

名稱	描述	值
automatic	指出索引編製原則是否為自動	bool
excludedPaths	要從索引編製中排除的路徑清單	ExcludedPath[]
includedPaths	要包含在索引中的路徑清單	IncludedPath[]
indexingMode	表示索引模式。	'一致' 'Lazy' 'None'

ExcludedPath

名稱	描述	值
path	套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

IncludedPath

名稱	描述	值
索引	此路徑的索引清單	Indexes[]
path	套用索引行為的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

索引

名稱	描述	值
dataType	套用索引行為的數據類型。	'LineString' 'MultiPolygon' 'Number' 'Point' 'Polygon' 'String'
kind	表示索引的類型。	'Hash' 'Range' 'Spatial'
精確度	索引的有效位數。 -1 是最大精確度。	int

ContainerPartitionKey

名稱	描述	值
kind	指出用於數據分割的演算法類型	'Hash' 'Range'
路徑	用來分割容器內數據的路徑清單	string[]

UniqueKeyPolicy

名稱	描述	值
uniqueKeys	在上強制執行 Azure Cosmos DB 服務集合中檔的唯一性條件約束的唯一索引鍵清單。	UniqueKey[]

UniqueKey

名稱	描述	值
路徑	Azure Cosmos DB 服務中每個文件的路徑清單都必須是唯一的	string[]

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@2016-03-31"
  name = "string"
  parent_id = "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"
              ]
            }
          ]
        }
      }
    }
  })
}

屬性值

databaseAccounts/apis/databases/graphs

名稱	描述	值
類型	資源類型	“Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs@2016-03-31”
NAME	資源名稱	字串 (必要)
parent_id	此資源之父系的資源標識碼。	類型資源的標識碼： 資料庫
properties	用來建立及更新 Azure Cosmos DB Gremlin 圖形的屬性。	GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphProp...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	Gremlin 圖形的標準 JSON 格式	需要 GremlinGraphResource ()

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

GremlinGraphResource

名稱	描述	值
conflictResolutionPolicy	圖表的衝突解決原則。	ConflictResolutionPolicy
defaultTtl	默認存留時間	int
id	Cosmos DB Gremlin 圖形的名稱	字串 (必要)
indexingPolicy	索引編製原則的組態。 根據預設，圖表內所有文件路徑的索引編製會自動	IndexingPolicy
partitionKey	分割區索引鍵的設定，用於將數據分割成多個分割區	ContainerPartitionKey
uniqueKeyPolicy	在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則設定。	UniqueKeyPolicy

ConflictResolutionPolicy

名稱	描述	值
conflictResolutionPath	LastWriterWins 模式的衝突解決路徑。	字串
conflictResolutionProcedure	解決自定義模式衝突的程式。	字串
mode	表示衝突解決模式。	"Custom" “LastWriterWins”

IndexingPolicy

名稱	描述	值
automatic	指出索引編製原則是否為自動	bool
excludedPaths	要從索引編製中排除的路徑清單	ExcludedPath[]
includedPaths	要包含在索引中的路徑清單	IncludedPath[]
indexingMode	表示索引編製模式。	“一致” “延遲” "None"

ExcludedPath

名稱	描述	值
path	索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

IncludedPath

名稱	描述	值
索引	此路徑的索引清單	Indexes[]
path	索引行為套用的路徑。 索引路徑通常以根開頭，並以通配符結尾 (/path/*)	字串

索引

名稱	描述	值
dataType	套用索引行為的數據類型。	“LineString” “MultiPolygon” “Number” “Point” “Polygon” “String”
kind	表示索引的類型。	“Hash” “Range” “Spatial”
精確度	索引的有效位數。 -1 是最大精確度。	int

ContainerPartitionKey

名稱	描述	值
kind	指出用於數據分割的演算法類型	“Hash” “Range”
路徑	用來分割容器內數據的路徑清單	string[]

UniqueKeyPolicy

名稱	描述	值
uniqueKeys	在上強制執行 Azure Cosmos DB 服務集合中檔的唯一性條件約束的唯一索引鍵清單。	UniqueKey[]

UniqueKey

名稱	描述	值
路徑	Azure Cosmos DB 服務中每個文件的路徑清單都必須是唯一的	string[]