Table of Contents

Interface IMongoDBResourcesOperations

Namespace
Microsoft.Azure.Management.CosmosDB.Fluent
Assembly
Microsoft.Azure.Management.CosmosDB.Fluent.dll

MongoDBResourcesOperations operations.

public interface IMongoDBResourcesOperations
Extension Methods

Methods

BeginCreateUpdateMongoDBCollectionWithHttpMessagesAsync(string, string, string, string, MongoDBCollectionCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>> BeginCreateUpdateMongoDBCollectionWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, MongoDBCollectionCreateUpdateParameters createUpdateMongoDBCollectionParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginCreateUpdateMongoDBDatabaseWithHttpMessagesAsync(string, string, string, MongoDBDatabaseCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or updates Azure Cosmos DB MongoDB database

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>> BeginCreateUpdateMongoDBDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, MongoDBDatabaseCreateUpdateParameters createUpdateMongoDBDatabaseParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteMongoDBCollectionWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB Collection.

Task<AzureOperationResponse> BeginDeleteMongoDBCollectionWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginDeleteMongoDBDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB database.

Task<AzureOperationResponse> BeginDeleteMongoDBDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginUpdateMongoDBCollectionThroughputWithHttpMessagesAsync(string, string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> BeginUpdateMongoDBCollectionThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

BeginUpdateMongoDBDatabaseThroughputWithHttpMessagesAsync(string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> BeginUpdateMongoDBDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateUpdateMongoDBCollectionWithHttpMessagesAsync(string, string, string, string, MongoDBCollectionCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or update an Azure Cosmos DB MongoDB Collection

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>> CreateUpdateMongoDBCollectionWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, MongoDBCollectionCreateUpdateParameters createUpdateMongoDBCollectionParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

CreateUpdateMongoDBDatabaseWithHttpMessagesAsync(string, string, string, MongoDBDatabaseCreateUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

Create or updates Azure Cosmos DB MongoDB database

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>> CreateUpdateMongoDBDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, MongoDBDatabaseCreateUpdateParameters createUpdateMongoDBDatabaseParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteMongoDBCollectionWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB Collection.

Task<AzureOperationResponse> DeleteMongoDBCollectionWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

DeleteMongoDBDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

Deletes an existing Azure Cosmos DB MongoDB database.

Task<AzureOperationResponse> DeleteMongoDBDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetMongoDBCollectionThroughputWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> GetMongoDBCollectionThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetMongoDBCollectionWithHttpMessagesAsync(string, string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>> GetMongoDBCollectionWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBCollectionGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetMongoDBDatabaseThroughputWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> GetMongoDBDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

GetMongoDBDatabaseWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>> GetMongoDBDatabaseWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<MongoDBDatabaseGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListMongoDBCollectionsWithHttpMessagesAsync(string, string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<MongoDBCollectionGetResultsInner>>> ListMongoDBCollectionsWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

databaseName string

Cosmos DB database name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<MongoDBCollectionGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

ListMongoDBDatabasesWithHttpMessagesAsync(string, string, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<IEnumerable<MongoDBDatabaseGetResultsInner>>> ListMongoDBDatabasesWithHttpMessagesAsync(string resourceGroupName, string accountName, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

resourceGroupName string

Name of an Azure resource group.

accountName string

Cosmos DB database account name.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IEnumerable<MongoDBDatabaseGetResultsInner>>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

UpdateMongoDBCollectionThroughputWithHttpMessagesAsync(string, string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> UpdateMongoDBCollectionThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, string collectionName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

UpdateMongoDBDatabaseThroughputWithHttpMessagesAsync(string, string, string, ThroughputSettingsUpdateParameters, Dictionary<string, List<string>>, CancellationToken)

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

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>> UpdateMongoDBDatabaseThroughputWithHttpMessagesAsync(string resourceGroupName, string accountName, string databaseName, ThroughputSettingsUpdateParameters updateThroughputParameters, Dictionary<string, List<string>> customHeaders = null, CancellationToken cancellationToken = default)

Parameters

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.

customHeaders Dictionary<string, List<string>>

The headers that will be added to request.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<ThroughputSettingsGetResultsInner>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null