MongoClusterCollection.Get(String, CancellationToken) Method

Definition

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 Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource> Get(string mongoClusterName, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.MongoCluster.MongoClusterResource>
Public Overridable Function Get (mongoClusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of MongoClusterResource)

Parameters

mongoClusterName
String

The name of the mongo cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

mongoClusterName is null.

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

Applies to