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

Gremlin Resources - List Gremlin Databases

列出现有 Azure Cosmos DB 数据库帐户下的 Gremlin 数据库。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases?api-version=2022-05-15

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索 Gremlin 数据库属性。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBGremlinDatabaseList

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases?api-version=2022-05-15

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName",
      "name": "databaseName",
      "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases",
      "location": "West US",
      "tags": {},
      "properties": {
        "resource": {
          "id": "databaseName",
          "_rid": "CqNBAA==",
          "_ts": 1449602962,
          "_etag": "\"00000a00-0000-0000-0000-56672f920000\""
        }
      }
    }
  ]
}

定义

AutoscaleSettings
GremlinDatabaseGetResults

Azure Cosmos DB Gremlin 数据库。

GremlinDatabaseListResult

包含 Gremlin 数据库及其属性的列表操作响应。

Options
Resource

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

表示最大吞吐量,资源可以纵向扩展。

GremlinDatabaseGetResults

Azure Cosmos DB Gremlin 数据库。

Name Type Description
id
  • string

ARM 资源的唯一资源标识符。

location
  • string

资源所属的资源组的位置。

name
  • string

ARM 资源的名称。

properties.options
properties.resource
tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

type
  • string

Azure 资源的类型。

GremlinDatabaseListResult

包含 Gremlin 数据库及其属性的列表操作响应。

Name Type Description
value

Gremlin 数据库及其属性的列表。

Options

Name Type Description
autoscaleSettings

指定自动缩放设置。

throughput
  • integer

Cosmos DB 资源吞吐量或自动缩放设置的值。 检索产品/服务详细信息时,请使用 ThroughputSetting 资源。

Resource

Name Type Description
_etag
  • string

一个系统生成的属性,表示乐观并发控制所需的资源 etag。

_rid
  • string

系统生成的属性。 唯一标识符。

_ts
  • number

一个系统生成的属性,表示资源的上次更新时间戳。

id
  • string

Cosmos DB Gremlin 数据库的名称