MongoClusterCollection Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

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

Source:

MongoClusterCollection.cs

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.CosmosDB.MongoClusterResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.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

Object

ArmCollection

MongoClusterCollection

Implements

IAsyncEnumerable<MongoClusterResource> IEnumerable<MongoClusterResource> IEnumerable

Constructors

MongoClusterCollection()

Initializes a new instance of the MongoClusterCollection class for mocking.

Properties

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

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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
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: 2024-02-15-preview Resource: MongoClusterResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmCollection)

Explicit Interface Implementations

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.