MongoDBDatabaseCollection.GetIfExistsAsync(String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.11
Source:
MongoDBDatabaseCollection.cs
Source:
MongoDBDatabaseCollection.cs

Tries to get details for this resource from the service.

  • 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.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>> GetIfExistsAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>>
Public Overridable Function GetIfExistsAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of MongoDBDatabaseResource))

Parameters

databaseName
String

Cosmos DB database name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<MongoDBDatabaseResource>>

Exceptions

ArgumentException

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

ArgumentNullException

databaseName is null.

Applies to