CosmosDBExtensions.GetMongoClusterAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.9

Source:: CosmosDBExtensions.cs

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.

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-02-15-preview
Resource: MongoClusterResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoClusterResource>> GetMongoClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string mongoClusterName, System.Threading.CancellationToken cancellationToken = default);

static member GetMongoClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDB.MongoClusterResource>>

<Extension()>
Public Function GetMongoClusterAsync (resourceGroupResource As ResourceGroupResource, mongoClusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of MongoClusterResource))

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

mongoClusterName: String

The name of the mongo cluster.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<MongoClusterResource>>

Exceptions

ArgumentNullException

resourceGroupResource or mongoClusterName is null.

ArgumentException

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

Applies to

Share via