MongoClusterCollection.Get(String, CancellationToken) Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

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

Source:: MongoClusterCollection.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 virtual Azure.Response<Azure.ResourceManager.CosmosDB.MongoClusterResource> Get (string mongoClusterName, System.Threading.CancellationToken cancellationToken = default);

abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.MongoClusterResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDB.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

Response<MongoClusterResource>

Exceptions

ArgumentException

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

ArgumentNullException

mongoClusterName is null.

Applies to

Share via