Mongo DB Resources - Get Mongo DB Database

Service:

Cosmos DB Resource Provider

Version d'API:

2025-04-15

Obtient les bases de données MongoDB sous un compte de base de données Azure Cosmos DB existant avec le nom fourni.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nom du compte de base de données Cosmos DB.
databaseName	path	True	string	Nom de la base de données Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	MongoDBDatabaseGetResults	La propriété de base de données MongoDB a été récupérée avec succès.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Usurper votre compte d'utilisateur

Exemples

CosmosDBMongoDBDatabaseGet

Exemple de requête

HTTP

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

Java

/**
 * Samples for MongoDBResources GetMongoDBDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBMongoDBDatabaseGet.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().getMongoDBDatabaseWithResponse("rg1",
            "ddb1", "databaseName", 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

Python

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_get.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.get_mongo_db_database(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseGet.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

Go

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/CosmosDBMongoDBDatabaseGet.json
func ExampleMongoDBResourcesClient_GetMongoDBDatabase() {
	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)
	}
	res, err := clientFactory.NewMongoDBResourcesClient().GetMongoDBDatabase(ctx, "rg1", "ddb1", "databaseName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MongoDBDatabaseGetResults = 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{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			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

JavaScript

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

/**
 * This sample demonstrates how to Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
 *
 * @summary Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseGet.json
 */
async function cosmosDbMongoDbdatabaseGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.getMongoDBDatabase(
    resourceGroupName,
    accountName,
    databaseName,
  );
  console.log(result);
}

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

Exemple de réponse

Code d’état:

200

{
  "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",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Définitions

Nom	Description
AutoscaleSettings
CreateMode	Enum to indicate the mode of account creation.
MongoDBDatabaseGetResults	Base de données MongoDB Azure Cosmos DB.
Options
Resource
ResourceRestoreParameters	Parameters to indicate the information about the restore.

AutoscaleSettings

Object

Nom	Type	Description
maxThroughput	integer	Représente le débit maximal, la ressource peut effectuer un scale-up.

CreateMode

Énumération

Enum to indicate the mode of account creation.

Valeur	Description
Default
Restore

MongoDBDatabaseGetResults

Object

Base de données MongoDB Azure Cosmos DB.

Nom	Type	Description
id	string	Identificateur de ressource unique de la ressource ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Nom de la ressource ARM.
properties.options	Options
properties.resource	Resource
tags	object	Les balises sont une liste de paires clé-valeur qui décrivent la ressource. Ces balises peuvent être utilisées dans l’affichage et le regroupement de cette ressource (entre les groupes de ressources). Un maximum de 15 balises peut être fourni pour une ressource. Chaque balise doit avoir une clé supérieure à 128 caractères et une valeur supérieure à 256 caractères. Par exemple, l’expérience par défaut d’un type de modèle est définie avec « defaultExperience » : « Cassandra ». Les valeurs « defaultExperience » actuelles incluent également « Table », « Graph », « DocumentDB » et « MongoDB ».
type	string	Type de ressource Azure.

Options

Object

Nom	Type	Description
autoscaleSettings	AutoscaleSettings	Spécifie les paramètres de mise à l’échelle automatique.
throughput	integer	Valeur du débit des ressources Cosmos DB ou de la mise à l’échelle automatique. Utilisez la ressource ThroughputSetting lors de la récupération des détails de l’offre.

Resource

Object

Nom	Type	Valeur par défaut	Description
_etag	string		Propriété générée par le système représentant l’etag de ressource requise pour le contrôle d’accès concurrentiel optimiste.
_rid	string		Propriété générée par le système. Un identificateur unique.
_ts	number		Propriété générée par le système qui désigne le dernier horodatage mis à jour de la ressource.
createMode	CreateMode	Default	Énumération pour indiquer le mode de création de ressources.
id	string		Nom de la base de données MongoDB Cosmos DB
restoreParameters	ResourceRestoreParameters		Paramètres pour indiquer les informations relatives à la restauration

ResourceRestoreParameters

Object

Parameters to indicate the information about the restore.

Nom	Type	Description
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	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.