Share via


MongoClusterExtensions.GetMongoClustersAsync Method

Definition

List all the mongo clusters in a given subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/mongoClusters
  • Operation Id: MongoCluster_List
  • Default Api Version: 2024-07-01
  • Resource: MongoClusterResource
public static Azure.AsyncPageable<Azure.ResourceManager.MongoCluster.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.MongoCluster.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

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

Exceptions

subscriptionResource is null.

Applies to