MongoDBDatabaseCollection.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

MongoDBDatabaseCollection.cs

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}
• Operation Id: MongoDBResources_GetMongoDBDatabase
• Default Api Version: 2024-09-01-preview
• Resource: MongoDBDatabaseResource

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>> GetAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>>

Public Overridable Function GetAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoDBDatabaseResource))

Parameters

databaseName

String

Cosmos DB database name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<MongoDBDatabaseResource>>

Exceptions

ArgumentException

databaseName is an empty string, and was expected to be non-empty.

ArgumentNullException

databaseName is null.