通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/gremlinDatabases/graphs 2019-12-12

  • 项目

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/gremlinDatabases/graphs 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-12-12' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      throughput: 'string'
    }
    resource: {
      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'
  }
}

属性值

CompositePath

名字 描述 价值
次序 复合路径的排序顺序。 “升序”
“降序”
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

ConflictResolutionPolicy

名字 描述 价值
conflictResolutionPath LastWriterWins 模式下的冲突解决路径。 字符串
conflictResolutionProcedure 解决自定义模式冲突的过程。 字符串
模式 指示冲突解决模式。 “Custom”
“LastWriterWins”

ContainerPartitionKey

名字 描述 价值
类 指示用于分区的算法类型 “Hash”
“Range”
路径 使用容器中的数据可以分区的路径列表 string[]
版本 指示分区键定义的版本 int

约束：
最小值 = 1
最大值 = 2

CreateUpdateOptions

名字 描述 价值
吞吐量 每秒请求单位数。 例如，“throughput”：“10000”。 字符串

ExcludedPath

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions （必需）
资源 Gremlin 图形的标准 JSON 格式 GremlinGraphResourceOrGremlinGraphGetPropertiesResource（必需）

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名字 描述 价值
conflictResolutionPolicy 图形的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB Gremlin 图形的名称 string （必需）
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
compositeIndexes 复合路径列表列表 CompositePath[][]
excludedPaths 要从索引中排除的路径列表 ExcludedPath[]
includedPaths 要包含在索引中的路径列表 IncludedPath[]
indexingMode 指示索引模式。 “一致”
“懒惰”
“None”
spatialIndexes 空间细节列表 SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名字 描述 价值
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts/gremlinDatabases
性能 用于创建和更新 Azure Cosmos DB Gremlin 图形的属性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

SpatialSpec

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串
类型 路径的空间类型列表 包含任一项的字符串数组：
“LineString”
“MultiPolygon”
“Point”
“Polygon”

标签

名字 描述 价值

UniqueKey

名字 描述 价值
路径 路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的 string[]

UniqueKeyPolicy

名字 描述 价值
uniqueKeys 在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。 UniqueKey[]

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
为 Gremlin API 创建 Azure Cosmos DB 帐户 此模板使用专用吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。
为 Gremlin API 自动缩放 创建 Azure Cosmos DB 帐户 此模板使用自动缩放吞吐量在两个区域中为 Gremlin API 创建 Azure Cosmos DB 帐户，其中包含一个数据库和一个图形。

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/gremlinDatabases/graphs 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs",
  "apiVersion": "2019-12-12",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "throughput": "string"
    },
    "resource": {
      "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"
  }
}

属性值

CompositePath

名字 描述 价值
次序 复合路径的排序顺序。 “升序”
“降序”
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

ConflictResolutionPolicy

名字 描述 价值
conflictResolutionPath LastWriterWins 模式下的冲突解决路径。 字符串
conflictResolutionProcedure 解决自定义模式冲突的过程。 字符串
模式 指示冲突解决模式。 “Custom”
“LastWriterWins”

ContainerPartitionKey

名字 描述 价值
类 指示用于分区的算法类型 “Hash”
“Range”
路径 使用容器中的数据可以分区的路径列表 string[]
版本 指示分区键定义的版本 int

约束：
最小值 = 1
最大值 = 2

CreateUpdateOptions

名字 描述 价值
吞吐量 每秒请求单位数。 例如，“throughput”：“10000”。 字符串

ExcludedPath

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions （必需）
资源 Gremlin 图形的标准 JSON 格式 GremlinGraphResourceOrGremlinGraphGetPropertiesResource（必需）

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名字 描述 价值
conflictResolutionPolicy 图形的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB Gremlin 图形的名称 string （必需）
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
compositeIndexes 复合路径列表列表 CompositePath[][]
excludedPaths 要从索引中排除的路径列表 ExcludedPath[]
includedPaths 要包含在索引中的路径列表 IncludedPath[]
indexingMode 指示索引模式。 “一致”
“懒惰”
“None”
spatialIndexes 空间细节列表 SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名字 描述 价值
apiVersion API 版本 '2019-12-12'
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
性能 用于创建和更新 Azure Cosmos DB Gremlin 图形的属性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties （必需）
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs”

SpatialSpec

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串
类型 路径的空间类型列表 包含任一项的字符串数组：
“LineString”
“MultiPolygon”
“Point”
“Polygon”

标签

名字 描述 价值

UniqueKey

名字 描述 价值
路径 路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的 string[]

UniqueKeyPolicy

名字 描述 价值
uniqueKeys 在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。 UniqueKey[]

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
为 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@2019-12-12"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        throughput = "string"
      }
      resource = {
        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"
              ]
            }
          ]
        }
      }
    }
  })
}

属性值

CompositePath

名字 描述 价值
次序 复合路径的排序顺序。 “升序”
“降序”
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

ConflictResolutionPolicy

名字 描述 价值
conflictResolutionPath LastWriterWins 模式下的冲突解决路径。 字符串
conflictResolutionProcedure 解决自定义模式冲突的过程。 字符串
模式 指示冲突解决模式。 “Custom”
“LastWriterWins”

ContainerPartitionKey

名字 描述 价值
类 指示用于分区的算法类型 “Hash”
“Range”
路径 使用容器中的数据可以分区的路径列表 string[]
版本 指示分区键定义的版本 int

约束：
最小值 = 1
最大值 = 2

CreateUpdateOptions

名字 描述 价值
吞吐量 每秒请求单位数。 例如，“throughput”：“10000”。 字符串

ExcludedPath

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串

GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties

名字 描述 价值
选项 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions （必需）
资源 Gremlin 图形的标准 JSON 格式 GremlinGraphResourceOrGremlinGraphGetPropertiesResource（必需）

GremlinGraphResourceOrGremlinGraphGetPropertiesResource

名字 描述 价值
conflictResolutionPolicy 图形的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB Gremlin 图形的名称 string （必需）
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
compositeIndexes 复合路径列表列表 CompositePath[][]
excludedPaths 要从索引中排除的路径列表 ExcludedPath[]
includedPaths 要包含在索引中的路径列表 IncludedPath[]
indexingMode 指示索引模式。 “一致”
“懒惰”
“None”
spatialIndexes 空间细节列表 SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs

名字 描述 价值
位置 资源所属的资源组的位置。 字符串
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts/gremlinDatabases
性能 用于创建和更新 Azure Cosmos DB Gremlin 图形的属性。 GremlinGraphCreateUpdatePropertiesOrGremlinGraphGetProperties （必需）
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/graphs@2019-12-12”

SpatialSpec

名字 描述 价值
路径 索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*） 字符串
类型 路径的空间类型列表 包含任一项的字符串数组：
“LineString”
“MultiPolygon”
“Point”
“Polygon”

标签

名字 描述 价值

UniqueKey

名字 描述 价值
路径 路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的 string[]

UniqueKeyPolicy

名字 描述 价值
uniqueKeys 在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。 UniqueKey[]