Mongo DB Resources - List Mongo DB Databases

既存の Azure Cosmos DB データベース アカウントの MongoDB データベースを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases?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

MongoDB データベースのプロパティが正常に取得されました。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

Name Description
user_impersonation ユーザー アカウントの借用

CosmosDBMongoDBDatabaseList

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName",
      "name": "databaseName",
      "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
      "location": "West US",
      "tags": {},
      "properties": {
        "resource": {
          "id": "databaseName"
        }
      }
    }
  ]
}

定義

AutoscaleSettings
MongoDBDatabaseGetResults

MongoDB データベースとそのプロパティの一覧。

MongoDBDatabaseListResult

MongoDB データベースとそのプロパティを含む List 操作応答。

Options
Resource

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

リソースをスケールアップできる最大スループットを表します。

MongoDBDatabaseGetResults

MongoDB データベースとそのプロパティの一覧。

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 リソースの種類。

MongoDBDatabaseListResult

MongoDB データベースとそのプロパティを含む List 操作応答。

Name Type Description
value

MongoDB データベースとそのプロパティの一覧。

Options

Name Type Description
autoscaleSettings

自動スケール設定を指定します。

throughput
  • integer

Cosmos DB リソースのスループットまたは autoscaleSettings の値。 オファーの詳細を取得するときは、ThroughputSetting リソースを使用します。

Resource

Name Type Description
_etag
  • string

オプティミスティック コンカレンシー制御に必要なリソース etag を表すシステム生成プロパティ。

_rid
  • string

システムによって生成されたプロパティ。 一意識別子。

_ts
  • number

リソースの最後に更新されたタイムスタンプを示すシステム生成プロパティ。

id
  • string

Cosmos DB MongoDB データベースの名前