MongoDBCollectionCollection.GetAsync(String, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the MongoDB collection under an existing Azure Cosmos DB database account.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}.
- Operation Id. : MongoDBCollectionGetResultsOperationGroup_GetMongoDBCollection.
- Default Api Version. : 2026-03-15.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>> GetAsync(string collectionName, System.Threading.CancellationToken cancellationToken = default);abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>Public Overridable Function GetAsync (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoDBCollectionResource))Parameters
- collectionName
- String
Cosmos DB collection name.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
collectionName is null.
collectionName is an empty string, and was expected to be non-empty.
