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

Microsoft.DocumentDB databaseAccounts/gremlinDatabases 2023-04-15

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/gremlinDatabases 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-04-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
}

属性值

databaseAccounts/gremlinDatabases

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型的资源的符号名称: databaseAccounts
properties 用于创建和更新 Azure Cosmos DB Gremlin 数据库的属性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... 所需的 ()

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

名称 说明 Value
options 要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Gremlin 数据库的标准 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... 所需的 ()

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

名称 说明
autoscaleSettings 指定自动缩放设置。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“throughput”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可以纵向扩展到的最大吞吐量。 int

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

名称 说明 Value
id Cosmos DB Gremlin 数据库的名称 字符串 (必需)

快速入门模板

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

模板 说明
为 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 资源类型:

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
  "apiVersion": "2023-04-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  }
}

属性值

databaseAccounts/gremlinDatabases

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases'
apiVersion 资源 API 版本 '2023-04-15'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
properties 用于创建和更新 Azure Cosmos DB Gremlin 数据库的属性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... 所需的 ()

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

名称 说明 Value
options 要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Gremlin 数据库的标准 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... 所需的 ()

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

名称 说明
autoscaleSettings 指定自动缩放设置。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“throughput”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可以纵向扩展到的最大吞吐量。 int

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

名称 说明 Value
id Cosmos DB Gremlin 数据库的名称 字符串 (必需)

快速入门模板

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

模板 说明
为 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 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-04-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  })
}

属性值

databaseAccounts/gremlinDatabases

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases@2023-04-15”
name 资源名称 字符串 (必需)
location 资源所属的资源组的位置。 字符串
parent_id 此资源的父资源的 ID。 类型的资源的 ID: databaseAccounts
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。
properties 用于创建和更新 Azure Cosmos DB Gremlin 数据库的属性。 GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba... 所需的 ()

GremlinDatabaseCreateUpdatePropertiesOrGremlinDataba...

名称 说明 Value
options 要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...
resource Gremlin 数据库的标准 JSON 格式 GremlinDatabaseResourceOrGremlinDatabaseGetPropertie... 所需的 ()

CreateUpdateOptionsOrGremlinDatabaseGetPropertiesOpt...

名称 说明
autoscaleSettings 指定自动缩放设置。 AutoscaleSettings
throughput 每秒请求单位数。 例如,“throughput”:10000。 int

AutoscaleSettings

名称 说明
maxThroughput 表示资源可以纵向扩展到的最大吞吐量。 int

GremlinDatabaseResourceOrGremlinDatabaseGetPropertie...

名称 说明 Value
id Cosmos DB Gremlin 数据库的名称 字符串 (必需)