Class MongoDBResourcesOperationsExtensions

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Extension methods for MongoDBResourcesOperations.

public static class MongoDBResourcesOperationsExtensions

Inheritance

object

MongoDBResourcesOperationsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

BeginCreateUpdateMongoDBCollectionAsync(IMongoDBResourcesOperations, string, string, string, string, MongoDBCollectionCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

public static Task<MongoDBCollectionGetResultsInner> BeginCreateUpdateMongoDBCollectionAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, MongoDBCollectionCreateUpdateParameters createUpdateMongoDBCollectionParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters

The parameters to provide for the current MongoDB Collection.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBCollectionGetResultsInner>

BeginCreateUpdateMongoDBDatabaseAsync(IMongoDBResourcesOperations, string, string, string, MongoDBDatabaseCreateUpdateParameters, CancellationToken)

Create or updates Azure Cosmos DB MongoDB database

public static Task<MongoDBDatabaseGetResultsInner> BeginCreateUpdateMongoDBDatabaseAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, MongoDBDatabaseCreateUpdateParameters createUpdateMongoDBDatabaseParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters

The parameters to provide for the current MongoDB database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBDatabaseGetResultsInner>

BeginDeleteMongoDBCollectionAsync(IMongoDBResourcesOperations, string, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB Collection.

public static Task BeginDeleteMongoDBCollectionAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginDeleteMongoDBDatabaseAsync(IMongoDBResourcesOperations, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB database.

public static Task BeginDeleteMongoDBDatabaseAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

BeginUpdateMongoDBCollectionThroughputAsync(IMongoDBResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update the RUs per second of an Azure Cosmos DB MongoDB collection

public static Task<ThroughputSettingsGetResultsInner> BeginUpdateMongoDBCollectionThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current MongoDB collection.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

BeginUpdateMongoDBDatabaseThroughputAsync(IMongoDBResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of the an Azure Cosmos DB MongoDB database

public static Task<ThroughputSettingsGetResultsInner> BeginUpdateMongoDBDatabaseThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current MongoDB database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

CreateUpdateMongoDBCollectionAsync(IMongoDBResourcesOperations, string, string, string, string, MongoDBCollectionCreateUpdateParameters, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

public static Task<MongoDBCollectionGetResultsInner> CreateUpdateMongoDBCollectionAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, MongoDBCollectionCreateUpdateParameters createUpdateMongoDBCollectionParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

createUpdateMongoDBCollectionParameters MongoDBCollectionCreateUpdateParameters

The parameters to provide for the current MongoDB Collection.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBCollectionGetResultsInner>

CreateUpdateMongoDBDatabaseAsync(IMongoDBResourcesOperations, string, string, string, MongoDBDatabaseCreateUpdateParameters, CancellationToken)

Create or updates Azure Cosmos DB MongoDB database

public static Task<MongoDBDatabaseGetResultsInner> CreateUpdateMongoDBDatabaseAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, MongoDBDatabaseCreateUpdateParameters createUpdateMongoDBDatabaseParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

createUpdateMongoDBDatabaseParameters MongoDBDatabaseCreateUpdateParameters

The parameters to provide for the current MongoDB database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBDatabaseGetResultsInner>

DeleteMongoDBCollectionAsync(IMongoDBResourcesOperations, string, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB Collection.

public static Task DeleteMongoDBCollectionAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

DeleteMongoDBDatabaseAsync(IMongoDBResourcesOperations, string, string, string, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB database.

public static Task DeleteMongoDBDatabaseAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

GetMongoDBCollectionAsync(IMongoDBResourcesOperations, string, string, string, string, CancellationToken)

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

public static Task<MongoDBCollectionGetResultsInner> GetMongoDBCollectionAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBCollectionGetResultsInner>

GetMongoDBCollectionThroughputAsync(IMongoDBResourcesOperations, string, string, string, string, CancellationToken)

Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.

public static Task<ThroughputSettingsGetResultsInner> GetMongoDBCollectionThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

GetMongoDBDatabaseAsync(IMongoDBResourcesOperations, string, string, string, CancellationToken)

Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

public static Task<MongoDBDatabaseGetResultsInner> GetMongoDBDatabaseAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<MongoDBDatabaseGetResultsInner>

GetMongoDBDatabaseThroughputAsync(IMongoDBResourcesOperations, string, string, string, CancellationToken)

Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.

public static Task<ThroughputSettingsGetResultsInner> GetMongoDBDatabaseThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

ListMongoDBCollectionsAsync(IMongoDBResourcesOperations, string, string, string, CancellationToken)

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

public static Task<IEnumerable<MongoDBCollectionGetResultsInner>> ListMongoDBCollectionsAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<MongoDBCollectionGetResultsInner>>

ListMongoDBDatabasesAsync(IMongoDBResourcesOperations, string, string, CancellationToken)

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

public static Task<IEnumerable<MongoDBDatabaseGetResultsInner>> ListMongoDBDatabasesAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IEnumerable<MongoDBDatabaseGetResultsInner>>

UpdateMongoDBCollectionThroughputAsync(IMongoDBResourcesOperations, string, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update the RUs per second of an Azure Cosmos DB MongoDB collection

public static Task<ThroughputSettingsGetResultsInner> UpdateMongoDBCollectionThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, string collectionName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

collectionName string

Cosmos DB collection name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current MongoDB collection.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>

UpdateMongoDBDatabaseThroughputAsync(IMongoDBResourcesOperations, string, string, string, ThroughputSettingsUpdateParameters, CancellationToken)

Update RUs per second of the an Azure Cosmos DB MongoDB database

public static Task<ThroughputSettingsGetResultsInner> UpdateMongoDBDatabaseThroughputAsync(this IMongoDBResourcesOperations operations, string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, CancellationToken cancellationToken = default)

Parameters

operations IMongoDBResourcesOperations

The operations group for this extension method.

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

updateThroughputParameters ThroughputSettingsUpdateParameters

The RUs per second of the parameters to provide for the current MongoDB database.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<ThroughputSettingsGetResultsInner>