Mongo DB Resources - List Mongo DB Databases

Ссылка

Служба:: Cosmos DB Resource Provider

Версия API:: 2025-04-15

Выводит список баз данных MongoDB в существующей учетной записи базы данных Azure Cosmos DB.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Имя учетной записи базы данных Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	MongoDBDatabaseListResult	Свойства базы данных MongoDB были успешно получены.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	Имитировать вашу учетную запись пользователя

Примеры

CosmosDBMongoDBDatabaseList

Образец запроса

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


/**
 * Samples for MongoDBResources ListMongoDBDatabases.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBMongoDBDatabaseList.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().listMongoDBDatabases("rgName", "ddb1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_mongo_db_database_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.mongo_db_resources.list_mongo_db_databases(
        resource_group_name="rgName",
        account_name="ddb1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseList.json
func ExampleMongoDBResourcesClient_NewListMongoDBDatabasesPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewMongoDBResourcesClient().NewListMongoDBDatabasesPager("rgName", "ddb1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MongoDBDatabaseListResult = armcosmos.MongoDBDatabaseListResult{
		// 	Value: []*armcosmos.MongoDBDatabaseGetResults{
		// 		{
		// 			Name: to.Ptr("databaseName"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/mongodbDatabases"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName"),
		// 			Location: to.Ptr("West US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcosmos.MongoDBDatabaseGetProperties{
		// 				Resource: &armcosmos.MongoDBDatabaseGetPropertiesResource{
		// 					ID: to.Ptr("databaseName"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists the MongoDB databases under an existing Azure Cosmos DB database account.
 *
 * @summary Lists the MongoDB databases under an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseList.json
 */
async function cosmosDbMongoDbdatabaseList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rgName";
  const accountName = "ddb1";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.mongoDBResources.listMongoDBDatabases(
    resourceGroupName,
    accountName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "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
CreateMode	Enum to indicate the mode of account creation.
MongoDBDatabaseGetResults	Список баз данных MongoDB и их свойств.
MongoDBDatabaseListResult	Ответ операции list, содержащий базы данных MongoDB и их свойства.
Options
Resource
ResourceRestoreParameters	Parameters to indicate the information about the restore.

AutoscaleSettings

Object

Имя	Тип	Описание
maxThroughput	integer	Представляет максимальную пропускную способность, ресурс может масштабироваться до.

CreateMode

Перечисление

Enum to indicate the mode of account creation.

Значение	Описание
Default
Restore

MongoDBDatabaseGetResults

Object

Список баз данных MongoDB и их свойств.

Имя	Тип	Описание
id	string	Уникальный идентификатор ресурса ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Имя ресурса ARM.
properties.options	Options
properties.resource	Resource
tags	object	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать для просмотра и группировки этого ресурса (между группами ресурсов). Для ресурса может быть предоставлено не более 15 тегов. Каждый тег должен иметь ключ не более 128 символов и значения не более 256 символов. Например, интерфейс по умолчанию для типа шаблона задается с параметром defaultExperience: Cassandra. Текущие значения defaultExperience также включают table, Graph, DocumentDB и MongoDB.
type	string	Тип ресурса Azure.

MongoDBDatabaseListResult

Object

Ответ операции list, содержащий базы данных MongoDB и их свойства.

Имя	Тип	Описание
value	MongoDBDatabaseGetResults[]	Список баз данных MongoDB и их свойств.

Options

Object

Имя	Тип	Описание
autoscaleSettings	AutoscaleSettings	Задает параметры автомасштабирования.
throughput	integer	Значение пропускной способности ресурсов Cosmos DB или автомасштабированияSettings. При получении сведений о предложении используйте ресурс Пропускной способности.

Resource

Object

Имя	Тип	Default value	Описание
_etag	string		Созданное системой свойство, представляющее etag ресурса, необходимое для управления оптимистичным параллелизмом.
_rid	string		Созданное системой свойство. Уникальный идентификатор.
_ts	number		Созданное системой свойство, обозначающее последнюю обновленную метку времени ресурса.
createMode	CreateMode	Default	Перечисление, указывающее режим создания ресурсов.
id	string		Имя базы данных MongoDB Cosmos DB
restoreParameters	ResourceRestoreParameters		Параметры для указания сведений о восстановлении

ResourceRestoreParameters

Object

Parameters to indicate the information about the restore.

Имя	Тип	Описание
restoreSource	string	The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Time to which the account has to be restored (ISO-8601 format).
restoreWithTtlDisabled	boolean	Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении.

Поделиться через

Mongo DB Resources - List Mongo DB Databases

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

CosmosDBMongoDBDatabaseList

Образец запроса

Пример ответа

Определения

AutoscaleSettings

CreateMode

MongoDBDatabaseGetResults

MongoDBDatabaseListResult

Options

Resource

ResourceRestoreParameters