CosmosDBExtensions.GetMongoClustersAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

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

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.

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.AsyncPageable<Azure.ResourceManager.CosmosDB.MongoClusterResource> GetMongoClustersAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

subscriptionResource: SubscriptionResource

The SubscriptionResource instance the method will execute against.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

AsyncPageable<MongoClusterResource>

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

Exceptions

ArgumentNullException

subscriptionResource is null.

Applies to