MongoDBCollectionCollection.ExistsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

MongoDBCollectionCollection.cs

Checks to see if the resource exists in azure.

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

public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string collectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member ExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>
override this.ExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<bool>>

Public Overridable Function ExistsAsync (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Boolean))

Parameters

collectionName

String

Cosmos DB collection name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<Boolean>>

Exceptions

ArgumentException

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

ArgumentNullException

collectionName is null.