CosmosDBExtensions.GetMongoClusters Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.4.0-beta.7

Overloads

GetMongoClusters(SubscriptionResource, CancellationToken)	List all the mongo clusters in a given subscription. Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters Operation Id: MongoClusters_List Default Api Version: 2024-02-15-preview Resource: MongoClusterResource
GetMongoClusters(ResourceGroupResource)	Gets a collection of MongoClusterResources in the ResourceGroupResource. MockingTo mock this method, please mock GetMongoClusters() instead.

GetMongoClusters(SubscriptionResource, CancellationToken)

Source:

CosmosDBExtensions.cs

List all the mongo clusters in a given subscription.

• Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters
• Operation Id: MongoClusters_List
• Default Api Version: 2024-02-15-preview
• Resource: MongoClusterResource

public static Azure.Pageable<Azure.ResourceManager.CosmosDB.MongoClusterResource> GetMongoClusters (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);

static member GetMongoClusters : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.CosmosDB.MongoClusterResource>

<Extension()>
Public Function GetMongoClusters (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of MongoClusterResource)

Parameters

subscriptionResource

SubscriptionResource

The SubscriptionResource instance the method will execute against.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<MongoClusterResource>

A collection of MongoClusterResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

subscriptionResource is null.

GetMongoClusters(ResourceGroupResource)

Source:

CosmosDBExtensions.cs

Gets a collection of MongoClusterResources in the ResourceGroupResource. MockingTo mock this method, please mock GetMongoClusters() instead.

public static Azure.ResourceManager.CosmosDB.MongoClusterCollection GetMongoClusters (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);

static member GetMongoClusters : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.CosmosDB.MongoClusterCollection

<Extension()>
Public Function GetMongoClusters (resourceGroupResource As ResourceGroupResource) As MongoClusterCollection

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

Returns

MongoClusterCollection

An object representing collection of MongoClusterResources and their operations over a MongoClusterResource.

Exceptions

ArgumentNullException

resourceGroupResource is null.