MongoClusterCollection Class

Definition

A class representing a collection of MongoClusterResource and their operations. Each MongoClusterResource in the collection will belong to the same instance of ResourceGroupResource. To get a MongoClusterCollection instance call the GetMongoClusters method from an instance of ResourceGroupResource.

public class MongoClusterCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.MongoCluster.MongoClusterResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.MongoCluster.MongoClusterResource>
type MongoClusterCollection = class
    inherit ArmCollection
    interface seq<MongoClusterResource>
    interface IEnumerable
    interface IAsyncEnumerable<MongoClusterResource>
Public Class MongoClusterCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of MongoClusterResource), IEnumerable(Of MongoClusterResource)
Inheritance
MongoClusterCollection
Implements

Constructors

Name Description
MongoClusterCollection()

Initializes a new instance of MongoClusterCollection for mocking.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

Name Description
CreateOrUpdate(WaitUntil, String, MongoClusterData, CancellationToken)

Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_CreateOrUpdate.
  • Default Api Version. : 2026-02-01-preview.
CreateOrUpdateAsync(WaitUntil, String, MongoClusterData, CancellationToken)

Create or update a mongo cluster. Update overwrites all properties for the resource. To only modify some of the properties, use PATCH.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_CreateOrUpdate.
  • Default Api Version. : 2026-02-01-preview.
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
Get(String, CancellationToken)

Gets information about a mongo cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
GetAll(CancellationToken)

List all the mongo clusters in a given resource group.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters.
  • Operation Id. : MongoClusters_ListByResourceGroup.
  • Default Api Version. : 2026-02-01-preview.
GetAllAsync(CancellationToken)

List all the mongo clusters in a given resource group.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters.
  • Operation Id. : MongoClusters_ListByResourceGroup.
  • Default Api Version. : 2026-02-01-preview.
GetAsync(String, CancellationToken)

Gets information about a mongo cluster.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/mongoClusters/{mongoClusterName}.
  • Operation Id. : MongoClusters_Get.
  • Default Api Version. : 2026-02-01-preview.
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

Name Description
IAsyncEnumerable<MongoClusterResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<MongoClusterResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Extension Methods

Name Description
ArrayContainsAll<T>(IEnumerable<T>, Object[])

Returns whether all values are present in the array.

ArrayContainsAny<T>(IEnumerable<T>, Object[])

Returns whether any values are present in the array.

Applies to