共用方式為

MongoDBDatabaseResource.GetMongoDBCollectionAsync 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

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 System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>> GetMongoDBCollectionAsync (string collectionName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMongoDBCollectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>
override this.GetMongoDBCollectionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>
Public Overridable Function GetMongoDBCollectionAsync (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

Task<Response<MongoDBCollectionResource>>

Exceptions

ArgumentNullException

collectionName is null.

ArgumentException

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

Applies to