MongoClusterCollection.GetAsync(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: 2024-07-01
  • Resource: MongoClusterResource
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

Exceptions

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

mongoClusterName is null.

Applies to