MongoDBResources | @azure/arm-cosmosdb

Interface representing a MongoDBResources.

Hierarchy

MongoDBResources

Implemented by

MongoDBResourcesImpl

Index

Methods

beginCreateUpdateMongoDBCollection

beginCreateUpdateMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBCollectionResponse>, MongoDBResourcesCreateUpdateMongoDBCollectionResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:433
Create or update an Azure Cosmos DB MongoDB Collection

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.
- Optional options: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBCollectionResponse>, MongoDBResourcesCreateUpdateMongoDBCollectionResponse>>

beginCreateUpdateMongoDBCollectionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:456
Create or update an Azure Cosmos DB MongoDB Collection

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.
- Optional options: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesCreateUpdateMongoDBCollectionResponse>

beginCreateUpdateMongoDBDatabase

beginCreateUpdateMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>, MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:147
Create or updates Azure Cosmos DB MongoDB database

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.
- Optional options: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>, MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>>

beginCreateUpdateMongoDBDatabaseAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:168
Create or updates Azure Cosmos DB MongoDB database

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.
- Optional options: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>

beginCreateUpdateMongoRoleDefinition

beginCreateUpdateMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>, MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:692
Creates or updates an Azure Cosmos DB Mongo Role Definition.

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.
- Optional options: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>, MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>>

beginCreateUpdateMongoRoleDefinitionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:715
Creates or updates an Azure Cosmos DB Mongo Role Definition.

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.
- Optional options: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>

beginCreateUpdateMongoUserDefinition

beginCreateUpdateMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>, MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:770
Creates or updates an Azure Cosmos DB Mongo User Definition.

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.
- Optional options: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>, MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>>

beginCreateUpdateMongoUserDefinitionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:793
Creates or updates an Azure Cosmos DB Mongo User Definition.

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.
- Optional options: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>

beginDeleteMongoDBCollection

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

- Defined in operationsInterfaces/mongoDBResources.ts:472
Deletes an existing Azure Cosmos DB MongoDB Collection.

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.
- Optional options: MongoDBResourcesDeleteMongoDBCollectionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteMongoDBCollectionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:487
Deletes an existing Azure Cosmos DB MongoDB Collection.

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.
- Optional options: MongoDBResourcesDeleteMongoDBCollectionOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteMongoDBDatabase

beginDeleteMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/mongoDBResources.ts:182
Deletes an existing Azure Cosmos DB MongoDB database.

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.
- Optional options: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteMongoDBDatabaseAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:195
Deletes an existing Azure Cosmos DB MongoDB database.

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.
- Optional options: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteMongoRoleDefinition

beginDeleteMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/mongoDBResources.ts:729
Deletes an existing Azure Cosmos DB Mongo Role Definition.

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.
- Optional options: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteMongoRoleDefinitionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:742
Deletes an existing Azure Cosmos DB Mongo Role Definition.

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.
- Optional options: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDeleteMongoUserDefinition

beginDeleteMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/mongoDBResources.ts:807
Deletes an existing Azure Cosmos DB Mongo User Definition.

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.
- Optional options: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteMongoUserDefinitionAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:820
Deletes an existing Azure Cosmos DB Mongo User Definition.

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.
- Optional options: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams
  
  The options parameters.
Returns Promise<void>

beginListMongoDBCollectionPartitionMerge

beginListMongoDBCollectionPartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>, MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:503
Merges the partitions of a MongoDB Collection

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.
- Optional options: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>, MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>>

beginListMongoDBCollectionPartitionMergeAndWait

beginListMongoDBCollectionPartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>

- Defined in operationsInterfaces/mongoDBResources.ts:527
Merges the partitions of a MongoDB Collection

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.
- Optional options: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesListMongoDBCollectionPartitionMergeResponse>

beginMigrateMongoDBCollectionToAutoscale

beginMigrateMongoDBCollectionToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse>, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:602
Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

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.
- Optional options: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse>, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse>>

beginMigrateMongoDBCollectionToAutoscaleAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:624
Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale

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.
- Optional options: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMigrateMongoDBCollectionToAutoscaleResponse>

beginMigrateMongoDBCollectionToManualThroughput

beginMigrateMongoDBCollectionToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse>, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:639
Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

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.
- Optional options: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse>, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse>>

beginMigrateMongoDBCollectionToManualThroughputAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:661
Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput

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.
- Optional options: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMigrateMongoDBCollectionToManualThroughputResponse>

beginMigrateMongoDBDatabaseToAutoscale

beginMigrateMongoDBDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse>, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:261
Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

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.
- Optional options: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse>, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse>>

beginMigrateMongoDBDatabaseToAutoscaleAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:281
Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale

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.
- Optional options: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleResponse>

beginMigrateMongoDBDatabaseToManualThroughput

beginMigrateMongoDBDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse>, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:294
Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

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.
- Optional options: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse>, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse>>

beginMigrateMongoDBDatabaseToManualThroughputAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:314
Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput

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.
- Optional options: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputResponse>

beginMongoDBContainerRedistributeThroughput

beginMongoDBContainerRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>, MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:375
Redistribute throughput for an Azure Cosmos DB MongoDB container

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.
- Optional options: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>, MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>>

beginMongoDBContainerRedistributeThroughputAndWait

beginMongoDBContainerRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>

- Defined in operationsInterfaces/mongoDBResources.ts:400
Redistribute throughput for an Azure Cosmos DB MongoDB container

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.
- Optional options: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMongoDBContainerRedistributeThroughputResponse>

beginMongoDBContainerRetrieveThroughputDistribution

beginMongoDBContainerRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:330
Retrieve throughput distribution for an Azure Cosmos DB MongoDB container

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.
- Optional options: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>>

beginMongoDBContainerRetrieveThroughputDistributionAndWait

beginMongoDBContainerRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>

- Defined in operationsInterfaces/mongoDBResources.ts:355
Retrieve throughput distribution for an Azure Cosmos DB MongoDB container

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.
- Optional options: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionResponse>

beginRetrieveContinuousBackupInformation

beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesRetrieveContinuousBackupInformationResponse>, MongoDBResourcesRetrieveContinuousBackupInformationResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:835
Retrieves continuous backup information for a Mongodb collection.

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.
- Optional options: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesRetrieveContinuousBackupInformationResponse>, MongoDBResourcesRetrieveContinuousBackupInformationResponse>>

beginRetrieveContinuousBackupInformationAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:859
Retrieves continuous backup information for a Mongodb collection.

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.
- Optional options: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesRetrieveContinuousBackupInformationResponse>

beginUpdateMongoDBCollectionThroughput

beginUpdateMongoDBCollectionThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesUpdateMongoDBCollectionThroughputResponse>, MongoDBResourcesUpdateMongoDBCollectionThroughputResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:561
Update the RUs per second of an Azure Cosmos DB MongoDB collection

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.
- Optional options: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesUpdateMongoDBCollectionThroughputResponse>, MongoDBResourcesUpdateMongoDBCollectionThroughputResponse>>

beginUpdateMongoDBCollectionThroughputAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:586
Update the RUs per second of an Azure Cosmos DB MongoDB collection

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.
- Optional options: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesUpdateMongoDBCollectionThroughputResponse>

beginUpdateMongoDBDatabaseThroughput

beginUpdateMongoDBDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams): Promise<PollerLike<PollOperationState<MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse>, MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse>>

- Defined in operationsInterfaces/mongoDBResources.ts:224
Update RUs per second of the an Azure Cosmos DB MongoDB database

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.
- Optional options: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse>, MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse>>

beginUpdateMongoDBDatabaseThroughputAndWait

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

- Defined in operationsInterfaces/mongoDBResources.ts:247
Update RUs per second of the an Azure Cosmos DB MongoDB database

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.
- Optional options: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesUpdateMongoDBDatabaseThroughputResponse>

getMongoDBCollection

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

- Defined in operationsInterfaces/mongoDBResources.ts:416
Gets the MongoDB collection under an existing Azure Cosmos DB database account.

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.
- Optional options: MongoDBResourcesGetMongoDBCollectionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoDBCollectionResponse>

getMongoDBCollectionThroughput

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

- Defined in operationsInterfaces/mongoDBResources.ts:544
Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoDBCollectionThroughputResponse>

getMongoDBDatabase

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

- Defined in operationsInterfaces/mongoDBResources.ts:132
Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: MongoDBResourcesGetMongoDBDatabaseOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoDBDatabaseResponse>

getMongoDBDatabaseThroughput

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

- Defined in operationsInterfaces/mongoDBResources.ts:209
Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.

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.
- Optional options: MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoDBDatabaseThroughputResponse>

getMongoRoleDefinition

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

- Defined in operationsInterfaces/mongoDBResources.ts:677
Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.

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.
- Optional options: MongoDBResourcesGetMongoRoleDefinitionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoRoleDefinitionResponse>

getMongoUserDefinition

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

- Defined in operationsInterfaces/mongoDBResources.ts:755
Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.

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.
- Optional options: MongoDBResourcesGetMongoUserDefinitionOptionalParams
  
  The options parameters.
Returns Promise<MongoDBResourcesGetMongoUserDefinitionResponse>

listMongoDBCollections

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

- Defined in operationsInterfaces/mongoDBResources.ts:96
Lists the MongoDB collection under an existing Azure Cosmos DB database account.

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.
- Optional options: MongoDBResourcesListMongoDBCollectionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MongoDBCollectionGetResults>

listMongoDBDatabases

listMongoDBDatabases(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoDBDatabasesOptionalParams): PagedAsyncIterableIterator<MongoDBDatabaseGetResults>

- Defined in operationsInterfaces/mongoDBResources.ts:84
Lists the MongoDB databases under an existing Azure Cosmos DB database account.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: MongoDBResourcesListMongoDBDatabasesOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MongoDBDatabaseGetResults>

listMongoRoleDefinitions

listMongoRoleDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoRoleDefinitionGetResults>

- Defined in operationsInterfaces/mongoDBResources.ts:108
Retrieves the list of all Azure Cosmos DB Mongo Role Definitions.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: MongoDBResourcesListMongoRoleDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MongoRoleDefinitionGetResults>

listMongoUserDefinitions

listMongoUserDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoUserDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoUserDefinitionGetResults>

- Defined in operationsInterfaces/mongoDBResources.ts:119
Retrieves the list of all Azure Cosmos DB Mongo User Definition.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- accountName: string
  
  Cosmos DB database account name.
- Optional options: MongoDBResourcesListMongoUserDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MongoUserDefinitionGetResults>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateUpdateMongoDBCollection

Parameters

resourceGroupName: string

accountName: string

databaseName: string

collectionName: string

createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams

Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBCollectionResponse>, MongoDBResourcesCreateUpdateMongoDBCollectionResponse>>

beginCreateUpdateMongoDBCollectionAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

collectionName: string

createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams

Returns Promise<MongoDBResourcesCreateUpdateMongoDBCollectionResponse>

beginCreateUpdateMongoDBDatabase

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams

Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>, MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>>

beginCreateUpdateMongoDBDatabaseAndWait

Parameters

resourceGroupName: string

accountName: string

databaseName: string

createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams

Returns Promise<MongoDBResourcesCreateUpdateMongoDBDatabaseResponse>

beginCreateUpdateMongoRoleDefinition

Parameters

mongoRoleDefinitionId: string

resourceGroupName: string

accountName: string

createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams

Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>, MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>>

beginCreateUpdateMongoRoleDefinitionAndWait

Parameters

mongoRoleDefinitionId: string

resourceGroupName: string

accountName: string

createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams

Returns Promise<MongoDBResourcesCreateUpdateMongoRoleDefinitionResponse>

beginCreateUpdateMongoUserDefinition

Parameters

mongoUserDefinitionId: string

resourceGroupName: string

accountName: string

createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams

Returns Promise<PollerLike<PollOperationState<MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>, MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>>

beginCreateUpdateMongoUserDefinitionAndWait

Parameters

mongoUserDefinitionId: string

resourceGroupName: string

accountName: string

createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters

Optional options: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams

Returns Promise<MongoDBResourcesCreateUpdateMongoUserDefinitionResponse>

beginDeleteMongoDBCollection

Parameters

resourceGroupName: string

accountName: string

databaseName: string

collectionName: string

Optional options: MongoDBResourcesDeleteMongoDBCollectionOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteMongoDBCollectionAndWait