MongoDBDatabaseCollection Class

Definition

Namespace:

Azure.ResourceManager.CosmosDB

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

MongoDBDatabaseCollection.cs

A class representing a collection of MongoDBDatabaseResource and their operations. Each MongoDBDatabaseResource in the collection will belong to the same instance of CosmosDBAccountResource. To get a MongoDBDatabaseCollection instance call the GetMongoDBDatabases method from an instance of CosmosDBAccountResource.

public class MongoDBDatabaseCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.MongoDBDatabaseResource>

type MongoDBDatabaseCollection = class
    inherit ArmCollection
    interface seq<MongoDBDatabaseResource>
    interface IEnumerable
    interface IAsyncEnumerable<MongoDBDatabaseResource>

Public Class MongoDBDatabaseCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of MongoDBDatabaseResource), IEnumerable(Of MongoDBDatabaseResource)

Inheritance

Object

ArmCollection

MongoDBDatabaseCollection

Implements

IAsyncEnumerable<MongoDBDatabaseResource> IEnumerable<MongoDBDatabaseResource> IEnumerable

Constructors

MongoDBDatabaseCollection()

Initializes a new instance of the MongoDBDatabaseCollection 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, MongoDBDatabaseCreateOrUpdateContent, CancellationToken)	Create or updates Azure Cosmos DB MongoDB database Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_CreateUpdateMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
CreateOrUpdateAsync(WaitUntil, String, MongoDBDatabaseCreateOrUpdateContent, CancellationToken)	Create or updates Azure Cosmos DB MongoDB database Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_CreateUpdateMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
Get(String, CancellationToken)	Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
GetAll(CancellationToken)	Lists the MongoDB databases under an existing Azure Cosmos DB database account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases Operation Id: MongoDBResources_ListMongoDBDatabases Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
GetAllAsync(CancellationToken)	Lists the MongoDB databases under an existing Azure Cosmos DB database account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases Operation Id: MongoDBResources_ListMongoDBDatabases Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
GetAsync(String, CancellationToken)	Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} Operation Id: MongoDBResources_GetMongoDBDatabase Default Api Version: 2024-09-01-preview Resource: MongoDBDatabaseResource
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<MongoDBDatabaseResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<MongoDBDatabaseResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.