MongoDBCollectionCollection Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.CosmosDB
Assembly:
Azure.ResourceManager.CosmosDB.dll
Package:
Azure.ResourceManager.CosmosDB v1.3.2
Package:
Azure.ResourceManager.CosmosDB v1.4.0-beta.11
Source:
MongoDBCollectionCollection.cs
Source:
MongoDBCollectionCollection.cs

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

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

Constructors

MongoDBCollectionCollection()

Initializes a new instance of the MongoDBCollectionCollection 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, MongoDBCollectionCreateOrUpdateContent, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
  • Operation Id: MongoDBResources_CreateUpdateMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
CreateOrUpdateAsync(WaitUntil, String, MongoDBCollectionCreateOrUpdateContent, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
  • Operation Id: MongoDBResources_CreateUpdateMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
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}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
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}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
Get(String, CancellationToken)

Gets the MongoDB collection under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
GetAll(CancellationToken)

Lists the MongoDB collection under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections
  • Operation Id: MongoDBResources_ListMongoDBCollections
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
GetAllAsync(CancellationToken)

Lists the MongoDB collection under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections
  • Operation Id: MongoDBResources_ListMongoDBCollections
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
GetAsync(String, CancellationToken)

Gets the MongoDB collection under an existing Azure Cosmos DB database account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
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}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
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}/collections/{collectionName}
  • Operation Id: MongoDBResources_GetMongoDBCollection
  • Default Api Version: 2024-09-01-preview
  • Resource: MongoDBCollectionResource
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<MongoDBCollectionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.
IEnumerable<MongoDBCollectionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to