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

Mongo DB Resources - Get Mongo DB Collection

获取现有 Azure Cosmos DB 数据库帐户下的 MongoDB 集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}?api-version=2024-05-15

URI 参数

名称 必需 类型 说明
accountName
path True

string

Cosmos DB 数据库帐户名称。

正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*

collectionName
path True

string

Cosmos DB 集合名称。

databaseName
path True

string

Cosmos DB 数据库名称。

resourceGroupName
path True

string

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

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

MongoDBCollectionGetResults

已成功检索 MongoDB 集合属性。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

CosmosDBMongoDBCollectionGet

示例请求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName?api-version=2024-05-15

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName",
  "name": "collectionName",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "testcoll",
      "indexes": [
        {
          "key": {
            "keys": [
              "testKey"
            ]
          },
          "options": {
            "expireAfterSeconds": 100,
            "unique": true
          }
        }
      ],
      "shardKey": {
        "testKey": "Hash"
      },
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

定义

名称 说明
AutoscaleSettings
CreateMode

用于指示帐户创建模式的枚举。

MongoDBCollectionGetResults

Azure Cosmos DB MongoDB 集合。

MongoIndex

Cosmos DB MongoDB 集合索引键

MongoIndexKeys

Cosmos DB MongoDB 集合资源对象

MongoIndexOptions

Cosmos DB MongoDB 集合索引选项

Options
Resource
ResourceRestoreParameters

指示有关还原的信息的参数。

AutoscaleSettings

名称 类型 说明
maxThroughput

integer

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

CreateMode

用于指示帐户创建模式的枚举。

名称 类型 说明
Default

string

Restore

string

MongoDBCollectionGetResults

Azure Cosmos DB MongoDB 集合。

名称 类型 说明
id

string

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

location

string

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

name

string

ARM 资源的名称。

properties.options

Options

properties.resource

Resource

tags

object

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

type

string

Azure 资源的类型。

MongoIndex

Cosmos DB MongoDB 集合索引键

名称 类型 说明
key

MongoIndexKeys

Cosmos DB MongoDB 集合索引键

options

MongoIndexOptions

Cosmos DB MongoDB 集合索引键选项

MongoIndexKeys

Cosmos DB MongoDB 集合资源对象

名称 类型 说明
keys

string[]

Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表

MongoIndexOptions

Cosmos DB MongoDB 集合索引选项

名称 类型 说明
expireAfterSeconds

integer

秒后过期

unique

boolean

是否唯一

Options

名称 类型 说明
autoscaleSettings

AutoscaleSettings

指定自动缩放设置。

throughput

integer

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

Resource

名称 类型 默认值 说明
_etag

string

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

_rid

string

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

_ts

number

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

analyticalStorageTtl

integer

分析 TTL。

createMode

CreateMode

Default

用于指示资源创建模式的枚举。

id

string

Cosmos DB MongoDB 集合的名称

indexes

MongoIndex[]

索引键列表

restoreParameters

ResourceRestoreParameters

指示有关还原的信息的参数

shardKey

object

要为请求应用的分片键的键值对。

ResourceRestoreParameters

指示有关还原的信息的参数。

名称 类型 说明
restoreSource

string

必须从中启动还原的可还原数据库帐户的 ID。 例如:/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string

帐户必须还原到的时间 (ISO-8601 格式) 。