共用方式為


Microsoft.DocumentDB 資料庫Accounts/gremlinDatabases/graphs

Bicep 資源定義

databaseAccounts/gremlinDatabases/graphs 資源類型可以使用目標作業來部署:

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

資源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      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'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/gremlinDatabases/graphs

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
location 資源所屬之資源群組的位置。 字串
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標籤
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: gremlinDatabases
properties 用來建立和更新 Azure Cosmos DB Gremlin 圖形的屬性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

名稱 描述
autoscaleSettings 指定自動調整設定。 注意:需要輸送量或 autoscaleSettings,但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加。 int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名稱 描述
分析StorageTtl 分析TTL。 int
conflictResolutionPolicy 圖表的衝突解決原則。 ConflictResolutionPolicy
createMode 表示資源建立模式的列舉。 'Default'
'Restore'
defaultTtl 默認存留時間 int
id Cosmos DB Gremlin 圖形的名稱 字串 (必要)
indexingPolicy 索引編製原則的組態。 根據預設,圖表內所有文件路徑的索引編製會自動 IndexingPolicy
partitionKey 分割區索引鍵的設定,用於將數據分割成多個分割區 ContainerPartitionKey
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters
uniqueKeyPolicy 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則設定。 UniqueKeyPolicy

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'

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 格式) 。 字串

UniqueKeyPolicy

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

UniqueKey

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

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Gremlin API 的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會在兩個區域中建立適用於 Gremlin API 的 Azure Cosmos DB 帳戶,並使用專用輸送量建立一個資料庫和一個圖形。
建立 Gremlin API 自動調整的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會使用自動調整輸送量,在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶,其中一個資料庫和一個圖形。

ARM 範本資源定義

databaseAccounts/gremlinDatabases/graphs 資源類型可以使用目標作業來部署:

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

資源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "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" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

屬性值

databaseAccounts/gremlinDatabases/graphs

名稱 描述
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs'
apiVersion 資源 API 版本 '2024-05-15'
NAME 資源名稱

瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。
需要字串 ()
location 資源所屬之資源群組的位置。 字串
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。 請參閱 範本中的標籤
properties 用來建立和更新 Azure Cosmos DB Gremlin 圖形的屬性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

名稱 描述
autoscaleSettings 指定自動調整設定。 注意:需要輸送量或 autoscaleSettings,但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加為 。 int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名稱 描述
分析StorageTtl 分析TTL。 int
conflictResolutionPolicy 圖形的衝突解決原則。 ConflictResolutionPolicy
createMode 列舉,表示資源建立模式。 'Default'
'Restore'
defaultTtl 默認存留時間 int
id Cosmos DB Gremlin 圖形的名稱 需要字串 ()
indexingPolicy 編製索引原則的組態。 根據預設,圖表內的所有文件路徑都會自動編製索引 IndexingPolicy
partitionKey 分割區索引鍵的設定,用於將數據分割成多個分割區 ContainerPartitionKey
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters
uniqueKeyPolicy 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則組態。 UniqueKeyPolicy

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'

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 格式) 。 字串

UniqueKeyPolicy

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

UniqueKey

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

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Gremlin API 的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會使用專用輸送量,在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶,其中一個資料庫和一個圖形。
建立 Gremlin API 自動調整的 Azure Cosmos DB 帳戶

部署至 Azure
此範本會使用自動調整輸送量,在兩個區域中建立 Gremlin API 的 Azure Cosmos DB 帳戶,其中包含一個資料庫和一個圖形。

Terraform (AzAPI 提供者) 資源定義

databaseAccounts/gremlinDatabases/graphs 資源類型可以使用目標作業來部署:

  • 資源群組

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

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-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
        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"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

屬性值

databaseAccounts/gremlinDatabases/graphs

名稱 描述
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2024-05-15”
NAME 資源名稱 需要字串 ()
location 資源所屬之資源群組的位置。 字串
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼: gremlinDatabases
tags 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源,以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元,值則不得多於 256 個字元。 例如,範本類型的默認體驗會設定為 「defaultExperience」:“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 標記名稱和值的字典。
properties 用來建立和更新 Azure Cosmos DB Gremlin 圖形的屬性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP... 必要 ()

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetP...

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

CreateUpdateOptionsOrGremlinGraphGetPropertiesOption...

名稱 描述
autoscaleSettings 指定自動調整設定。 注意:需要輸送量或 autoscaleSettings,但不需要兩者。 AutoscaleSettings
輸送量 每秒要求單位數。 例如,「輸送量」:10000。 int

AutoscaleSettings

名稱 描述
maxThroughput 代表最大輸送量,資源可以相應增加。 int

GremlinGraphResourceOrGremlinGraphGetPropertiesResou...

名稱 描述
分析StorageTtl 分析TTL。 int
conflictResolutionPolicy 圖表的衝突解決原則。 ConflictResolutionPolicy
createMode 表示資源建立模式的列舉。 “Default”
“Restore”
defaultTtl 默認存留時間 int
id Cosmos DB Gremlin 圖形的名稱 字串 (必要)
indexingPolicy 索引編製原則的組態。 根據預設,圖表內所有文件路徑的索引編製會自動 IndexingPolicy
partitionKey 分割區索引鍵的設定,用於將數據分割成多個分割區 ContainerPartitionKey
restoreParameters 用來指出還原相關信息的參數 ResourceRestoreParameters
uniqueKeyPolicy 在 Azure Cosmos DB 服務集合中指定檔的唯一性條件約束的唯一索引鍵原則設定。 UniqueKeyPolicy

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”

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 格式) 。 字串

UniqueKeyPolicy

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

UniqueKey

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