MongoDBResources interface

Interface representing a MongoDBResources.

Methods

beginCreateUpdateMongoDBCollection(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)

Create or update an Azure Cosmos DB MongoDB Collection

beginCreateUpdateMongoDBCollectionAndWait(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)

Create or update an Azure Cosmos DB MongoDB Collection

beginCreateUpdateMongoDBDatabase(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)

Create or updates Azure Cosmos DB MongoDB database

beginCreateUpdateMongoDBDatabaseAndWait(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)

Create or updates Azure Cosmos DB MongoDB database

beginCreateUpdateMongoRoleDefinition(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo Role Definition.

beginCreateUpdateMongoRoleDefinitionAndWait(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo Role Definition.

beginCreateUpdateMongoUserDefinition(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo User Definition.

beginCreateUpdateMongoUserDefinitionAndWait(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo User Definition.

beginDeleteMongoDBCollection(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB Collection.

beginDeleteMongoDBCollectionAndWait(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB Collection.

beginDeleteMongoDBDatabase(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB database.

beginDeleteMongoDBDatabaseAndWait(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB database.

beginDeleteMongoRoleDefinition(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo Role Definition.

beginDeleteMongoRoleDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo Role Definition.

beginDeleteMongoUserDefinition(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo User Definition.

beginDeleteMongoUserDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo User Definition.

beginMigrateMongoDBCollectionToAutoscale(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

beginMigrateMongoDBCollectionToAutoscaleAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

beginMigrateMongoDBCollectionToManualThroughput(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

beginMigrateMongoDBCollectionToManualThroughputAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

beginMigrateMongoDBDatabaseToAutoscale(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

beginMigrateMongoDBDatabaseToAutoscaleAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

beginMigrateMongoDBDatabaseToManualThroughput(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

beginMigrateMongoDBDatabaseToManualThroughputAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a Mongodb collection.

beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a Mongodb collection.

beginUpdateMongoDBCollectionThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)

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

beginUpdateMongoDBCollectionThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)

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

beginUpdateMongoDBDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)

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

beginUpdateMongoDBDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)

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

getMongoDBCollection(string, string, string, string, MongoDBResourcesGetMongoDBCollectionOptionalParams)

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

getMongoDBCollectionThroughput(string, string, string, string, MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams)

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

getMongoDBDatabase(string, string, string, MongoDBResourcesGetMongoDBDatabaseOptionalParams)

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

getMongoDBDatabaseThroughput(string, string, string, MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams)

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

getMongoRoleDefinition(string, string, string, MongoDBResourcesGetMongoRoleDefinitionOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

getMongoUserDefinition(string, string, string, MongoDBResourcesGetMongoUserDefinitionOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

listMongoDBCollections(string, string, string, MongoDBResourcesListMongoDBCollectionsOptionalParams)

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

listMongoDBDatabases(string, string, MongoDBResourcesListMongoDBDatabasesOptionalParams)

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

listMongoRoleDefinitions(string, string, MongoDBResourcesListMongoRoleDefinitionsOptionalParams)

Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.

listMongoUserDefinitions(string, string, MongoDBResourcesListMongoUserDefinitionsOptionalParams)

Retrieves the list of all Azure Cosmos DB Mongo User Definition.

Method Details

beginCreateUpdateMongoDBCollection(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)

Create or update an Azure Cosmos DB MongoDB Collection

function beginCreateUpdateMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>>

beginCreateUpdateMongoDBCollectionAndWait(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)

Create or update an Azure Cosmos DB MongoDB Collection

function beginCreateUpdateMongoDBCollectionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams): Promise<MongoDBCollectionGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

beginCreateUpdateMongoDBDatabase(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)

Create or updates Azure Cosmos DB MongoDB database

function beginCreateUpdateMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

createUpdateMongoDBDatabaseParameters
MongoDBDatabaseCreateUpdateParameters

The parameters to provide for the current MongoDB database.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>>

beginCreateUpdateMongoDBDatabaseAndWait(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)

Create or updates Azure Cosmos DB MongoDB database

function beginCreateUpdateMongoDBDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams): Promise<MongoDBDatabaseGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

createUpdateMongoDBDatabaseParameters
MongoDBDatabaseCreateUpdateParameters

The parameters to provide for the current MongoDB database.

Returns

beginCreateUpdateMongoRoleDefinition(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo Role Definition.

function beginCreateUpdateMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>>

Parameters

mongoRoleDefinitionId

string

The ID for the Role Definition {dbName.roleName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

createUpdateMongoRoleDefinitionParameters
MongoRoleDefinitionCreateUpdateParameters

The properties required to create or update a Role Definition.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>>

beginCreateUpdateMongoRoleDefinitionAndWait(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo Role Definition.

function beginCreateUpdateMongoRoleDefinitionAndWait(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams): Promise<MongoRoleDefinitionGetResults>

Parameters

mongoRoleDefinitionId

string

The ID for the Role Definition {dbName.roleName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

createUpdateMongoRoleDefinitionParameters
MongoRoleDefinitionCreateUpdateParameters

The properties required to create or update a Role Definition.

Returns

beginCreateUpdateMongoUserDefinition(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo User Definition.

function beginCreateUpdateMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>>

Parameters

mongoUserDefinitionId

string

The ID for the User Definition {dbName.userName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

createUpdateMongoUserDefinitionParameters
MongoUserDefinitionCreateUpdateParameters

The properties required to create or update a User Definition.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>>

beginCreateUpdateMongoUserDefinitionAndWait(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)

Creates or updates an Azure Cosmos DB Mongo User Definition.

function beginCreateUpdateMongoUserDefinitionAndWait(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams): Promise<MongoUserDefinitionGetResults>

Parameters

mongoUserDefinitionId

string

The ID for the User Definition {dbName.userName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

createUpdateMongoUserDefinitionParameters
MongoUserDefinitionCreateUpdateParameters

The properties required to create or update a User Definition.

Returns

beginDeleteMongoDBCollection(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB Collection.

function beginDeleteMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBCollectionHeaders>, MongoDBResourcesDeleteMongoDBCollectionHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

beginDeleteMongoDBCollectionAndWait(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB Collection.

function beginDeleteMongoDBCollectionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams): Promise<MongoDBResourcesDeleteMongoDBCollectionHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

beginDeleteMongoDBDatabase(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB database.

function beginDeleteMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBDatabaseHeaders>, MongoDBResourcesDeleteMongoDBDatabaseHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options
MongoDBResourcesDeleteMongoDBDatabaseOptionalParams

The options parameters.

Returns

beginDeleteMongoDBDatabaseAndWait(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)

Deletes an existing Azure Cosmos DB MongoDB database.

function beginDeleteMongoDBDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams): Promise<MongoDBResourcesDeleteMongoDBDatabaseHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options
MongoDBResourcesDeleteMongoDBDatabaseOptionalParams

The options parameters.

Returns

beginDeleteMongoRoleDefinition(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo Role Definition.

function beginDeleteMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

mongoRoleDefinitionId

string

The ID for the Role Definition {dbName.roleName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteMongoRoleDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo Role Definition.

function beginDeleteMongoRoleDefinitionAndWait(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams): Promise<void>

Parameters

mongoRoleDefinitionId

string

The ID for the Role Definition {dbName.roleName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

Promise<void>

beginDeleteMongoUserDefinition(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo User Definition.

function beginDeleteMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

mongoUserDefinitionId

string

The ID for the User Definition {dbName.userName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteMongoUserDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)

Deletes an existing Azure Cosmos DB Mongo User Definition.

function beginDeleteMongoUserDefinitionAndWait(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams): Promise<void>

Parameters

mongoUserDefinitionId

string

The ID for the User Definition {dbName.userName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

Promise<void>

beginMigrateMongoDBCollectionToAutoscale(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

function beginMigrateMongoDBCollectionToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateMongoDBCollectionToAutoscaleAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

function beginMigrateMongoDBCollectionToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

beginMigrateMongoDBCollectionToManualThroughput(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

function beginMigrateMongoDBCollectionToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateMongoDBCollectionToManualThroughputAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

function beginMigrateMongoDBCollectionToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

beginMigrateMongoDBDatabaseToAutoscale(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

function beginMigrateMongoDBDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateMongoDBDatabaseToAutoscaleAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

function beginMigrateMongoDBDatabaseToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

beginMigrateMongoDBDatabaseToManualThroughput(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

function beginMigrateMongoDBDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginMigrateMongoDBDatabaseToManualThroughputAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)

Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

function beginMigrateMongoDBDatabaseToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a Mongodb collection.

function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

location
ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>

beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)

Retrieves continuous backup information for a Mongodb collection.

function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

location
ContinuousBackupRestoreLocation

The name of the continuous backup restore location.

Returns

beginUpdateMongoDBCollectionThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)

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

function beginUpdateMongoDBCollectionThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateMongoDBCollectionThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)

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

function beginUpdateMongoDBCollectionThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

beginUpdateMongoDBDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)

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

function beginUpdateMongoDBDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>

beginUpdateMongoDBDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)

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

function beginUpdateMongoDBDatabaseThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

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.

Returns

getMongoDBCollection(string, string, string, string, MongoDBResourcesGetMongoDBCollectionOptionalParams)

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

function getMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesGetMongoDBCollectionOptionalParams): Promise<MongoDBCollectionGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

options
MongoDBResourcesGetMongoDBCollectionOptionalParams

The options parameters.

Returns

getMongoDBCollectionThroughput(string, string, string, string, MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams)

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

function getMongoDBCollectionThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

collectionName

string

Cosmos DB collection name.

Returns

getMongoDBDatabase(string, string, string, MongoDBResourcesGetMongoDBDatabaseOptionalParams)

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

function getMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesGetMongoDBDatabaseOptionalParams): Promise<MongoDBDatabaseGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

options
MongoDBResourcesGetMongoDBDatabaseOptionalParams

The options parameters.

Returns

getMongoDBDatabaseThroughput(string, string, string, MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams)

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

function getMongoDBDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

getMongoRoleDefinition(string, string, string, MongoDBResourcesGetMongoRoleDefinitionOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

function getMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesGetMongoRoleDefinitionOptionalParams): Promise<MongoRoleDefinitionGetResults>

Parameters

mongoRoleDefinitionId

string

The ID for the Role Definition {dbName.roleName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

getMongoUserDefinition(string, string, string, MongoDBResourcesGetMongoUserDefinitionOptionalParams)

Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

function getMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesGetMongoUserDefinitionOptionalParams): Promise<MongoUserDefinitionGetResults>

Parameters

mongoUserDefinitionId

string

The ID for the User Definition {dbName.userName}.

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

listMongoDBCollections(string, string, string, MongoDBResourcesListMongoDBCollectionsOptionalParams)

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

function listMongoDBCollections(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesListMongoDBCollectionsOptionalParams): PagedAsyncIterableIterator<MongoDBCollectionGetResults, MongoDBCollectionGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

databaseName

string

Cosmos DB database name.

Returns

listMongoDBDatabases(string, string, MongoDBResourcesListMongoDBDatabasesOptionalParams)

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

function listMongoDBDatabases(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoDBDatabasesOptionalParams): PagedAsyncIterableIterator<MongoDBDatabaseGetResults, MongoDBDatabaseGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

options
MongoDBResourcesListMongoDBDatabasesOptionalParams

The options parameters.

Returns

listMongoRoleDefinitions(string, string, MongoDBResourcesListMongoRoleDefinitionsOptionalParams)

Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.

function listMongoRoleDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoRoleDefinitionGetResults, MongoRoleDefinitionGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns

listMongoUserDefinitions(string, string, MongoDBResourcesListMongoUserDefinitionsOptionalParams)

Retrieves the list of all Azure Cosmos DB Mongo User Definition.

function listMongoUserDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoUserDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoUserDefinitionGetResults, MongoUserDefinitionGetResults[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

Cosmos DB database account name.

Returns