MongoDBResourcesOperations interface

Package:

@azure/arm-cosmosdb

Interface representing a MongoDBResources operations.

Properties

beginCreateUpdateMongoDBCollection
beginCreateUpdateMongoDBCollectionAndWait
beginCreateUpdateMongoDBDatabase
beginCreateUpdateMongoDBDatabaseAndWait
beginCreateUpdateMongoRoleDefinition
beginCreateUpdateMongoRoleDefinitionAndWait
beginCreateUpdateMongoUserDefinition
beginCreateUpdateMongoUserDefinitionAndWait
beginDeleteMongoDBCollection
beginDeleteMongoDBCollectionAndWait
beginDeleteMongoDBDatabase
beginDeleteMongoDBDatabaseAndWait
beginDeleteMongoRoleDefinition
beginDeleteMongoRoleDefinitionAndWait
beginDeleteMongoUserDefinition
beginDeleteMongoUserDefinitionAndWait
beginMigrateMongoDBCollectionToAutoscale
beginMigrateMongoDBCollectionToAutoscaleAndWait
beginMigrateMongoDBCollectionToManualThroughput
beginMigrateMongoDBCollectionToManualThroughputAndWait
beginMigrateMongoDBDatabaseToAutoscale
beginMigrateMongoDBDatabaseToAutoscaleAndWait
beginMigrateMongoDBDatabaseToManualThroughput
beginMigrateMongoDBDatabaseToManualThroughputAndWait
beginRetrieveContinuousBackupInformation
beginRetrieveContinuousBackupInformationAndWait
beginUpdateMongoDBCollectionThroughput
beginUpdateMongoDBCollectionThroughputAndWait
beginUpdateMongoDBDatabaseThroughput
beginUpdateMongoDBDatabaseThroughputAndWait
createUpdateMongoDBCollection	Create or update an Azure Cosmos DB MongoDB Collection
createUpdateMongoDBDatabase	Create or updates Azure Cosmos DB MongoDB database
createUpdateMongoRoleDefinition	Creates or updates an Azure Cosmos DB Mongo Role Definition.
createUpdateMongoUserDefinition	Creates or updates an Azure Cosmos DB Mongo User Definition.
deleteMongoDBCollection	Deletes an existing Azure Cosmos DB MongoDB Collection.
deleteMongoDBDatabase	Deletes an existing Azure Cosmos DB MongoDB database.
deleteMongoRoleDefinition	Deletes an existing Azure Cosmos DB Mongo Role Definition.
deleteMongoUserDefinition	Deletes an existing Azure Cosmos DB Mongo User Definition.
getMongoDBCollection	Gets the MongoDB collection under an existing Azure Cosmos DB database account.
getMongoDBCollectionThroughput	Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.
getMongoDBDatabase	Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
getMongoDBDatabaseThroughput	Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.
getMongoRoleDefinition	Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
getMongoUserDefinition	Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
listMongoDBCollections	Lists the MongoDB collection under an existing Azure Cosmos DB database account.
listMongoDBDatabases	Lists the MongoDB databases under an existing Azure Cosmos DB database account.
listMongoRoleDefinitions	Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.
listMongoUserDefinitions	Retrieves the list of all Azure Cosmos DB Mongo User Definition.
migrateMongoDBCollectionToAutoscale	Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale
migrateMongoDBCollectionToManualThroughput	Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput
migrateMongoDBDatabaseToAutoscale	Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
migrateMongoDBDatabaseToManualThroughput	Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput
retrieveContinuousBackupInformation	Retrieves continuous backup information for a Mongodb collection.
updateMongoDBCollectionThroughput	Update the RUs per second of an Azure Cosmos DB MongoDB collection
updateMongoDBDatabaseThroughput	Update RUs per second of the an Azure Cosmos DB MongoDB database

Property Details

beginCreateUpdateMongoDBCollection

Warning

This API is now deprecated.

use createUpdateMongoDBCollection instead

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

Property Value

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

beginCreateUpdateMongoDBCollectionAndWait

Warning

This API is now deprecated.

use createUpdateMongoDBCollection instead

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

Property Value

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

beginCreateUpdateMongoDBDatabase

Warning

This API is now deprecated.

use createUpdateMongoDBDatabase instead

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

Property Value

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

beginCreateUpdateMongoDBDatabaseAndWait

Warning

This API is now deprecated.

use createUpdateMongoDBDatabase instead

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

Property Value

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

beginCreateUpdateMongoRoleDefinition

Warning

This API is now deprecated.

use createUpdateMongoRoleDefinition instead

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

Property Value

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

beginCreateUpdateMongoRoleDefinitionAndWait

Warning

This API is now deprecated.

use createUpdateMongoRoleDefinition instead

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

Property Value

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

beginCreateUpdateMongoUserDefinition

Warning

This API is now deprecated.

use createUpdateMongoUserDefinition instead

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

Property Value

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

beginCreateUpdateMongoUserDefinitionAndWait

Warning

This API is now deprecated.

use createUpdateMongoUserDefinition instead

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

Property Value

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

beginDeleteMongoDBCollection

Warning

This API is now deprecated.

use deleteMongoDBCollection instead

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

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteMongoDBCollectionAndWait

Warning

This API is now deprecated.

use deleteMongoDBCollection instead

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

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams) => Promise<void>

beginDeleteMongoDBDatabase

Warning

This API is now deprecated.

use deleteMongoDBDatabase instead

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

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteMongoDBDatabaseAndWait

Warning

This API is now deprecated.

use deleteMongoDBDatabase instead

beginDeleteMongoDBDatabaseAndWait: (resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams) => Promise<void>

beginDeleteMongoRoleDefinition

Warning

This API is now deprecated.

use deleteMongoRoleDefinition instead

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

Property Value

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

beginDeleteMongoRoleDefinitionAndWait

Warning

This API is now deprecated.

use deleteMongoRoleDefinition instead

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

Property Value

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

beginDeleteMongoUserDefinition

Warning

This API is now deprecated.

use deleteMongoUserDefinition instead

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

Property Value

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

beginDeleteMongoUserDefinitionAndWait

Warning

This API is now deprecated.

use deleteMongoUserDefinition instead

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

Property Value

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

beginMigrateMongoDBCollectionToAutoscale

Warning

This API is now deprecated.

use migrateMongoDBCollectionToAutoscale instead

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

Property Value

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

beginMigrateMongoDBCollectionToAutoscaleAndWait

Warning

This API is now deprecated.

use migrateMongoDBCollectionToAutoscale instead

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

Property Value

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

beginMigrateMongoDBCollectionToManualThroughput

Warning

This API is now deprecated.

use migrateMongoDBCollectionToManualThroughput instead

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

Property Value

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

beginMigrateMongoDBCollectionToManualThroughputAndWait

Warning

This API is now deprecated.

use migrateMongoDBCollectionToManualThroughput instead

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

Property Value

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

beginMigrateMongoDBDatabaseToAutoscale

Warning

This API is now deprecated.

use migrateMongoDBDatabaseToAutoscale instead

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

Property Value

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

beginMigrateMongoDBDatabaseToAutoscaleAndWait

Warning

This API is now deprecated.

use migrateMongoDBDatabaseToAutoscale instead

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

Property Value

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

beginMigrateMongoDBDatabaseToManualThroughput

Warning

This API is now deprecated.

use migrateMongoDBDatabaseToManualThroughput instead

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

Property Value

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

beginMigrateMongoDBDatabaseToManualThroughputAndWait

Warning

This API is now deprecated.

use migrateMongoDBDatabaseToManualThroughput instead

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

Property Value

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

beginRetrieveContinuousBackupInformation

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

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

Property Value

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

beginRetrieveContinuousBackupInformationAndWait

Warning

This API is now deprecated.

use retrieveContinuousBackupInformation instead

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

Property Value

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

beginUpdateMongoDBCollectionThroughput

Warning

This API is now deprecated.

use updateMongoDBCollectionThroughput instead

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

Property Value

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

beginUpdateMongoDBCollectionThroughputAndWait

Warning

This API is now deprecated.

use updateMongoDBCollectionThroughput instead

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

Property Value

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

beginUpdateMongoDBDatabaseThroughput

Warning

This API is now deprecated.

use updateMongoDBDatabaseThroughput instead

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

Property Value

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

beginUpdateMongoDBDatabaseThroughputAndWait

Warning

This API is now deprecated.

use updateMongoDBDatabaseThroughput instead

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

Property Value

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

createUpdateMongoDBCollection

Create or update an Azure Cosmos DB MongoDB Collection

createUpdateMongoDBCollection: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams) => PollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams) => PollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>

createUpdateMongoDBDatabase

Create or updates Azure Cosmos DB MongoDB database

createUpdateMongoDBDatabase: (resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams) => PollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams) => PollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>

createUpdateMongoRoleDefinition

Creates or updates an Azure Cosmos DB Mongo Role Definition.

createUpdateMongoRoleDefinition: (resourceGroupName: string, accountName: string, mongoRoleDefinitionId: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams) => PollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>

Property Value

(resourceGroupName: string, accountName: string, mongoRoleDefinitionId: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams) => PollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>

createUpdateMongoUserDefinition

Creates or updates an Azure Cosmos DB Mongo User Definition.

createUpdateMongoUserDefinition: (resourceGroupName: string, accountName: string, mongoUserDefinitionId: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams) => PollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>

Property Value

(resourceGroupName: string, accountName: string, mongoUserDefinitionId: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams) => PollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>

deleteMongoDBCollection

Deletes an existing Azure Cosmos DB MongoDB Collection.

deleteMongoDBCollection: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams) => PollerLike<OperationState<void>, void>

deleteMongoDBDatabase

Deletes an existing Azure Cosmos DB MongoDB database.

deleteMongoDBDatabase: (resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams) => PollerLike<OperationState<void>, void>

deleteMongoRoleDefinition

Deletes an existing Azure Cosmos DB Mongo Role Definition.

deleteMongoRoleDefinition: (resourceGroupName: string, accountName: string, mongoRoleDefinitionId: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, mongoRoleDefinitionId: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

deleteMongoUserDefinition

Deletes an existing Azure Cosmos DB Mongo User Definition.

deleteMongoUserDefinition: (resourceGroupName: string, accountName: string, mongoUserDefinitionId: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, mongoUserDefinitionId: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams) => PollerLike<OperationState<void>, void>

getMongoDBCollection

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

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

Property Value

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

getMongoDBCollectionThroughput

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

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

Property Value

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

getMongoDBDatabase

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

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

Property Value

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

getMongoDBDatabaseThroughput

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

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

Property Value

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

getMongoRoleDefinition

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

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

Property Value

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

getMongoUserDefinition

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

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

Property Value

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

listMongoDBCollections

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

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

Property Value

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

listMongoDBDatabases

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

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

Property Value

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

listMongoRoleDefinitions

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

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

Property Value

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

listMongoUserDefinitions

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

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

Property Value

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

migrateMongoDBCollectionToAutoscale

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

migrateMongoDBCollectionToAutoscale: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateMongoDBCollectionToManualThroughput

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

migrateMongoDBCollectionToManualThroughput: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateMongoDBDatabaseToAutoscale

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

migrateMongoDBDatabaseToAutoscale: (resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

migrateMongoDBDatabaseToManualThroughput

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

migrateMongoDBDatabaseToManualThroughput: (resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

retrieveContinuousBackupInformation

Retrieves continuous backup information for a Mongodb collection.

retrieveContinuousBackupInformation: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams) => PollerLike<OperationState<BackupInformation>, BackupInformation>

updateMongoDBCollectionThroughput

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

updateMongoDBCollectionThroughput: (resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

updateMongoDBDatabaseThroughput

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

updateMongoDBDatabaseThroughput: (resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>

Property Value

(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams) => PollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>