MongoDBDatabaseResource.GetMongoDBCollection 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:: MongoDBDatabaseResource.cs

Source:: MongoDBDatabaseResource.cs

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: MongoDBResources_GetMongoDBCollection
Default Api Version: 2024-09-01-preview
Resource: MongoDBCollectionResource

public virtual Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource> GetMongoDBCollection (string collectionName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMongoDBCollection : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>
override this.GetMongoDBCollection : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>

Public Overridable Function GetMongoDBCollection (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of MongoDBCollectionResource)

Parameters

collectionName: String

Cosmos DB collection name.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<MongoDBCollectionResource>

Exceptions

ArgumentNullException

collectionName is null.

ArgumentException

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

Applies to

Share via