MongoDBCollectionCollection.GetIfExistsAsync 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.
Tries to get details for this resource from the service.
- 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.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>> GetIfExistsAsync (string collectionName, System.Threading.CancellationToken cancellationToken = default);abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.CosmosDB.MongoDBCollectionResource>>Public Overridable Function GetIfExistsAsync (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of MongoDBCollectionResource))Parameters
- collectionName
- String
Cosmos DB collection name.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
collectionName is an empty string, and was expected to be non-empty.
collectionName is null.
