MongoClusterCollection.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.MongoCluster

Assembly:

Azure.ResourceManager.MongoCluster.dll

Package:

Azure.ResourceManager.MongoCluster v1.0.0

Source:

MongoClusterCollection.cs

Gets information about a mongo cluster.

• Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
• Operation Id. : MongoClusters_Get.
• Default Api Version. : 2026-02-01-preview.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>> GetAsync(string mongoClusterName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>>

Public Overridable Function GetAsync (mongoClusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoClusterResource))

Parameters

mongoClusterName

String

The name of the mongo cluster.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<MongoClusterResource>>

Exceptions

ArgumentNullException

mongoClusterName is null.

ArgumentException

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