MongoClusterExtensions.GetMongoClusterAsync Method

Definition

Namespace:

Azure.ResourceManager.MongoCluster

Assembly:

Azure.ResourceManager.MongoCluster.dll

Package:

Azure.ResourceManager.MongoCluster v1.1.0

Source:

MongoClusterExtensions.cs

Gets information about a mongo cluster. <item> Mocking. To mock this method, please mock GetMongoClusterAsync(String, CancellationToken) instead. </item>

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.MongoCluster.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.MongoCluster.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 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

ArgumentException

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

ArgumentNullException

resourceGroupResource is null.