MongoDBResources interface
Interface representing a MongoDBResources.
Methods
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<MongoDBCollectionGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<MongoDBDatabaseGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<MongoRoleDefinitionGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<MongoUserDefinitionGetResults>
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.
The options parameters.
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.
The options parameters.
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.
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.
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.
The options parameters.
Returns
Promise<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.
The options parameters.
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.
The options parameters.
Returns
Promise<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.
The options parameters.
Returns
Promise<void>
beginListMongoDBCollectionPartitionMerge(string, string, string, string, MergeParameters, MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams)
Merges the partitions of a MongoDB Collection
function beginListMongoDBCollectionPartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>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.
- mergeParameters
- MergeParameters
The parameters for the merge operation.
The options parameters.
Returns
beginListMongoDBCollectionPartitionMergeAndWait(string, string, string, string, MergeParameters, MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams)
Merges the partitions of a MongoDB Collection
function beginListMongoDBCollectionPartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>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.
- mergeParameters
- MergeParameters
The parameters for the merge operation.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
beginMongoDBContainerRedistributeThroughput(string, string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams)
Redistribute throughput for an Azure Cosmos DB MongoDB container
function beginMongoDBContainerRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>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.
- redistributeThroughputParameters
- RedistributeThroughputParameters
The parameters to provide for redistributing throughput for the current MongoDB container.
The options parameters.
Returns
beginMongoDBContainerRedistributeThroughputAndWait(string, string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams)
Redistribute throughput for an Azure Cosmos DB MongoDB container
function beginMongoDBContainerRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>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.
- redistributeThroughputParameters
- RedistributeThroughputParameters
The parameters to provide for redistributing throughput for the current MongoDB container.
The options parameters.
Returns
beginMongoDBContainerRetrieveThroughputDistribution(string, string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams)
Retrieve throughput distribution for an Azure Cosmos DB MongoDB container
function beginMongoDBContainerRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>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.
- retrieveThroughputParameters
- RetrieveThroughputParameters
The parameters to provide for retrieving throughput distribution for the current MongoDB container.
The options parameters.
Returns
beginMongoDBContainerRetrieveThroughputDistributionAndWait(string, string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams)
Retrieve throughput distribution for an Azure Cosmos DB MongoDB container
function beginMongoDBContainerRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>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.
- retrieveThroughputParameters
- RetrieveThroughputParameters
The parameters to provide for retrieving throughput distribution for the current MongoDB container.
The options parameters.
Returns
beginMongoDBDatabasePartitionMerge(string, string, string, MergeParameters, MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams)
Merges the partitions of a MongoDB database
function beginMongoDBDatabasePartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>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.
- mergeParameters
- MergeParameters
The parameters for the merge operation.
The options parameters.
Returns
beginMongoDBDatabasePartitionMergeAndWait(string, string, string, MergeParameters, MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams)
Merges the partitions of a MongoDB database
function beginMongoDBDatabasePartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>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.
- mergeParameters
- MergeParameters
The parameters for the merge operation.
The options parameters.
Returns
beginMongoDBDatabaseRedistributeThroughput(string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams)
Redistribute throughput for an Azure Cosmos DB MongoDB database
function beginMongoDBDatabaseRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>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.
- redistributeThroughputParameters
- RedistributeThroughputParameters
The parameters to provide for redistributing throughput for the current MongoDB database.
The options parameters.
Returns
beginMongoDBDatabaseRedistributeThroughputAndWait(string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams)
Redistribute throughput for an Azure Cosmos DB MongoDB database
function beginMongoDBDatabaseRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>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.
- redistributeThroughputParameters
- RedistributeThroughputParameters
The parameters to provide for redistributing throughput for the current MongoDB database.
The options parameters.
Returns
beginMongoDBDatabaseRetrieveThroughputDistribution(string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams)
Retrieve throughput distribution for an Azure Cosmos DB MongoDB database
function beginMongoDBDatabaseRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>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.
- retrieveThroughputParameters
- RetrieveThroughputParameters
The parameters to provide for retrieving throughput distribution for the current MongoDB database.
The options parameters.
Returns
beginMongoDBDatabaseRetrieveThroughputDistributionAndWait(string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams)
Retrieve throughput distribution for an Azure Cosmos DB MongoDB database
function beginMongoDBDatabaseRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>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.
- retrieveThroughputParameters
- RetrieveThroughputParameters
The parameters to provide for retrieving throughput distribution for the current MongoDB database.
The options parameters.
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<BackupInformation>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<MongoDBCollectionGetResults>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<MongoDBDatabaseGetResults>
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.
The options parameters.
Returns
Promise<ThroughputSettingsGetResults>
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.
The options parameters.
Returns
Promise<MongoRoleDefinitionGetResults>
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.
The options parameters.
Returns
Promise<MongoUserDefinitionGetResults>
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.
The options parameters.
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.
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.
The options parameters.
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.
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for