MongoDBResources interface
表示 MongoDBResources 的接口。
方法
方法详细信息
beginCreateUpdateMongoDBCollection(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)
创建或更新 Azure Cosmos DB MongoDB 集合
function beginCreateUpdateMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- createUpdateMongoDBCollectionParameters
- MongoDBCollectionCreateUpdateParameters
要为当前 MongoDB 集合提供的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBCollectionGetResults>, MongoDBCollectionGetResults>>
beginCreateUpdateMongoDBCollectionAndWait(string, string, string, string, MongoDBCollectionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams)
创建或更新 Azure Cosmos DB MongoDB 集合
function beginCreateUpdateMongoDBCollectionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, createUpdateMongoDBCollectionParameters: MongoDBCollectionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBCollectionOptionalParams): Promise<MongoDBCollectionGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- createUpdateMongoDBCollectionParameters
- MongoDBCollectionCreateUpdateParameters
要为当前 MongoDB 集合提供的参数。
返回
Promise<MongoDBCollectionGetResults>
beginCreateUpdateMongoDBDatabase(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)
创建或更新 Azure Cosmos DB MongoDB 数据库
function beginCreateUpdateMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- createUpdateMongoDBDatabaseParameters
- MongoDBDatabaseCreateUpdateParameters
要为当前 MongoDB 数据库提供的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBDatabaseGetResults>, MongoDBDatabaseGetResults>>
beginCreateUpdateMongoDBDatabaseAndWait(string, string, string, MongoDBDatabaseCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams)
创建或更新 Azure Cosmos DB MongoDB 数据库
function beginCreateUpdateMongoDBDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, createUpdateMongoDBDatabaseParameters: MongoDBDatabaseCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoDBDatabaseOptionalParams): Promise<MongoDBDatabaseGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- createUpdateMongoDBDatabaseParameters
- MongoDBDatabaseCreateUpdateParameters
要为当前 MongoDB 数据库提供的参数。
返回
Promise<MongoDBDatabaseGetResults>
beginCreateUpdateMongoRoleDefinition(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)
创建或更新 Azure Cosmos DB Mongo 角色定义。
function beginCreateUpdateMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>>
参数
- mongoRoleDefinitionId
-
string
角色定义 {dbName.roleName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateMongoRoleDefinitionParameters
- MongoRoleDefinitionCreateUpdateParameters
创建或更新角色定义所需的属性。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoRoleDefinitionGetResults>, MongoRoleDefinitionGetResults>>
beginCreateUpdateMongoRoleDefinitionAndWait(string, string, string, MongoRoleDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams)
创建或更新 Azure Cosmos DB Mongo 角色定义。
function beginCreateUpdateMongoRoleDefinitionAndWait(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoRoleDefinitionParameters: MongoRoleDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoRoleDefinitionOptionalParams): Promise<MongoRoleDefinitionGetResults>
参数
- mongoRoleDefinitionId
-
string
角色定义 {dbName.roleName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateMongoRoleDefinitionParameters
- MongoRoleDefinitionCreateUpdateParameters
创建或更新角色定义所需的属性。
返回
Promise<MongoRoleDefinitionGetResults>
beginCreateUpdateMongoUserDefinition(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)
创建或更新 Azure Cosmos DB Mongo 用户定义。
function beginCreateUpdateMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>>
参数
- mongoUserDefinitionId
-
string
用户定义 {dbName.userName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateMongoUserDefinitionParameters
- MongoUserDefinitionCreateUpdateParameters
创建或更新用户定义所需的属性。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoUserDefinitionGetResults>, MongoUserDefinitionGetResults>>
beginCreateUpdateMongoUserDefinitionAndWait(string, string, string, MongoUserDefinitionCreateUpdateParameters, MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams)
创建或更新 Azure Cosmos DB Mongo 用户定义。
function beginCreateUpdateMongoUserDefinitionAndWait(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, createUpdateMongoUserDefinitionParameters: MongoUserDefinitionCreateUpdateParameters, options?: MongoDBResourcesCreateUpdateMongoUserDefinitionOptionalParams): Promise<MongoUserDefinitionGetResults>
参数
- mongoUserDefinitionId
-
string
用户定义 {dbName.userName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- createUpdateMongoUserDefinitionParameters
- MongoUserDefinitionCreateUpdateParameters
创建或更新用户定义所需的属性。
返回
Promise<MongoUserDefinitionGetResults>
beginDeleteMongoDBCollection(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)
删除现有的 Azure Cosmos DB MongoDB 集合。
function beginDeleteMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBCollectionHeaders>, MongoDBResourcesDeleteMongoDBCollectionHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBCollectionHeaders>, MongoDBResourcesDeleteMongoDBCollectionHeaders>>
beginDeleteMongoDBCollectionAndWait(string, string, string, string, MongoDBResourcesDeleteMongoDBCollectionOptionalParams)
删除现有的 Azure Cosmos DB MongoDB 集合。
function beginDeleteMongoDBCollectionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesDeleteMongoDBCollectionOptionalParams): Promise<MongoDBResourcesDeleteMongoDBCollectionHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
选项参数。
返回
beginDeleteMongoDBDatabase(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)
删除现有的 Azure Cosmos DB MongoDB 数据库。
function beginDeleteMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBDatabaseHeaders>, MongoDBResourcesDeleteMongoDBDatabaseHeaders>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<MongoDBResourcesDeleteMongoDBDatabaseHeaders>, MongoDBResourcesDeleteMongoDBDatabaseHeaders>>
beginDeleteMongoDBDatabaseAndWait(string, string, string, MongoDBResourcesDeleteMongoDBDatabaseOptionalParams)
删除现有的 Azure Cosmos DB MongoDB 数据库。
function beginDeleteMongoDBDatabaseAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesDeleteMongoDBDatabaseOptionalParams): Promise<MongoDBResourcesDeleteMongoDBDatabaseHeaders>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
选项参数。
返回
beginDeleteMongoRoleDefinition(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)
删除现有的 Azure Cosmos DB Mongo 角色定义。
function beginDeleteMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- mongoRoleDefinitionId
-
string
角色定义 {dbName.roleName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteMongoRoleDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams)
删除现有的 Azure Cosmos DB Mongo 角色定义。
function beginDeleteMongoRoleDefinitionAndWait(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoRoleDefinitionOptionalParams): Promise<void>
参数
- mongoRoleDefinitionId
-
string
角色定义 {dbName.roleName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<void>
beginDeleteMongoUserDefinition(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)
删除现有的 Azure Cosmos DB Mongo 用户定义。
function beginDeleteMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
参数
- mongoUserDefinitionId
-
string
用户定义 {dbName.userName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteMongoUserDefinitionAndWait(string, string, string, MongoDBResourcesDeleteMongoUserDefinitionOptionalParams)
删除现有的 Azure Cosmos DB Mongo 用户定义。
function beginDeleteMongoUserDefinitionAndWait(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesDeleteMongoUserDefinitionOptionalParams): Promise<void>
参数
- mongoUserDefinitionId
-
string
用户定义 {dbName.userName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<void>
beginListMongoDBCollectionPartitionMerge(string, string, string, string, MergeParameters, MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams)
合并 MongoDB 集合的分区
function beginListMongoDBCollectionPartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- mergeParameters
- MergeParameters
合并操作的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>
beginListMongoDBCollectionPartitionMergeAndWait(string, string, string, string, MergeParameters, MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams)
合并 MongoDB 集合的分区
function beginListMongoDBCollectionPartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesListMongoDBCollectionPartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- mergeParameters
- MergeParameters
合并操作的参数。
返回
beginMigrateMongoDBCollectionToAutoscale(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)
将 Azure Cosmos DB MongoDB 集合从手动吞吐量迁移到自动缩放
function beginMigrateMongoDBCollectionToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateMongoDBCollectionToAutoscaleAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams)
将 Azure Cosmos DB MongoDB 集合从手动吞吐量迁移到自动缩放
function beginMigrateMongoDBCollectionToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
返回
Promise<ThroughputSettingsGetResults>
beginMigrateMongoDBCollectionToManualThroughput(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)
将 Azure Cosmos DB MongoDB 集合从自动缩放迁移到手动吞吐量
function beginMigrateMongoDBCollectionToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateMongoDBCollectionToManualThroughputAndWait(string, string, string, string, MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams)
将 Azure Cosmos DB MongoDB 集合从自动缩放迁移到手动吞吐量
function beginMigrateMongoDBCollectionToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesMigrateMongoDBCollectionToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
返回
Promise<ThroughputSettingsGetResults>
beginMigrateMongoDBDatabaseToAutoscale(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)
将 Azure Cosmos DB MongoDB 数据库从手动吞吐量迁移到自动缩放
function beginMigrateMongoDBDatabaseToAutoscale(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateMongoDBDatabaseToAutoscaleAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams)
将 Azure Cosmos DB MongoDB 数据库从手动吞吐量迁移到自动缩放
function beginMigrateMongoDBDatabaseToAutoscaleAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToAutoscaleOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
返回
Promise<ThroughputSettingsGetResults>
beginMigrateMongoDBDatabaseToManualThroughput(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)
将 Azure Cosmos DB MongoDB 数据库从自动缩放迁移到手动吞吐量
function beginMigrateMongoDBDatabaseToManualThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginMigrateMongoDBDatabaseToManualThroughputAndWait(string, string, string, MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams)
将 Azure Cosmos DB MongoDB 数据库从自动缩放迁移到手动吞吐量
function beginMigrateMongoDBDatabaseToManualThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesMigrateMongoDBDatabaseToManualThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
返回
Promise<ThroughputSettingsGetResults>
beginMongoDBContainerRedistributeThroughput(string, string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams)
重新分发 Azure Cosmos DB MongoDB 容器的吞吐量
function beginMongoDBContainerRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- redistributeThroughputParameters
- RedistributeThroughputParameters
用于重新分发当前 MongoDB 容器的吞吐量的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
beginMongoDBContainerRedistributeThroughputAndWait(string, string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams)
重新分发 Azure Cosmos DB MongoDB 容器的吞吐量
function beginMongoDBContainerRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBContainerRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- redistributeThroughputParameters
- RedistributeThroughputParameters
用于重新分发当前 MongoDB 容器的吞吐量的参数。
返回
beginMongoDBContainerRetrieveThroughputDistribution(string, string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams)
检索 Azure Cosmos DB MongoDB 容器的吞吐量分布
function beginMongoDBContainerRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- retrieveThroughputParameters
- RetrieveThroughputParameters
用于检索当前 MongoDB 容器的吞吐量分布的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
beginMongoDBContainerRetrieveThroughputDistributionAndWait(string, string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams)
检索 Azure Cosmos DB MongoDB 容器的吞吐量分布
function beginMongoDBContainerRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBContainerRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- retrieveThroughputParameters
- RetrieveThroughputParameters
用于检索当前 MongoDB 容器的吞吐量分布的参数。
返回
beginMongoDBDatabasePartitionMerge(string, string, string, MergeParameters, MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams)
合并 MongoDB 数据库的分区
function beginMongoDBDatabasePartitionMerge(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- mergeParameters
- MergeParameters
合并操作的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionStorageInfoCollection>, PhysicalPartitionStorageInfoCollection>>
beginMongoDBDatabasePartitionMergeAndWait(string, string, string, MergeParameters, MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams)
合并 MongoDB 数据库的分区
function beginMongoDBDatabasePartitionMergeAndWait(resourceGroupName: string, accountName: string, databaseName: string, mergeParameters: MergeParameters, options?: MongoDBResourcesMongoDBDatabasePartitionMergeOptionalParams): Promise<PhysicalPartitionStorageInfoCollection>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- mergeParameters
- MergeParameters
合并操作的参数。
返回
beginMongoDBDatabaseRedistributeThroughput(string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams)
重新分发 Azure Cosmos DB MongoDB 数据库的吞吐量
function beginMongoDBDatabaseRedistributeThroughput(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- redistributeThroughputParameters
- RedistributeThroughputParameters
用于重新分发当前 MongoDB 数据库的吞吐量的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
beginMongoDBDatabaseRedistributeThroughputAndWait(string, string, string, RedistributeThroughputParameters, MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams)
重新分发 Azure Cosmos DB MongoDB 数据库的吞吐量
function beginMongoDBDatabaseRedistributeThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, redistributeThroughputParameters: RedistributeThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRedistributeThroughputOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- redistributeThroughputParameters
- RedistributeThroughputParameters
用于重新分发当前 MongoDB 数据库的吞吐量的参数。
返回
beginMongoDBDatabaseRetrieveThroughputDistribution(string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams)
检索 Azure Cosmos DB MongoDB 数据库的吞吐量分布
function beginMongoDBDatabaseRetrieveThroughputDistribution(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams): Promise<SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- retrieveThroughputParameters
- RetrieveThroughputParameters
用于检索当前 MongoDB 数据库的吞吐量分布的参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<PhysicalPartitionThroughputInfoResult>, PhysicalPartitionThroughputInfoResult>>
beginMongoDBDatabaseRetrieveThroughputDistributionAndWait(string, string, string, RetrieveThroughputParameters, MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams)
检索 Azure Cosmos DB MongoDB 数据库的吞吐量分布
function beginMongoDBDatabaseRetrieveThroughputDistributionAndWait(resourceGroupName: string, accountName: string, databaseName: string, retrieveThroughputParameters: RetrieveThroughputParameters, options?: MongoDBResourcesMongoDBDatabaseRetrieveThroughputDistributionOptionalParams): Promise<PhysicalPartitionThroughputInfoResult>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- retrieveThroughputParameters
- RetrieveThroughputParameters
用于检索当前 MongoDB 数据库的吞吐量分布的参数。
返回
beginRetrieveContinuousBackupInformation(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)
检索 Mongodb 集合的连续备份信息。
function beginRetrieveContinuousBackupInformation(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- location
- ContinuousBackupRestoreLocation
连续备份还原位置的名称。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupInformation>, BackupInformation>>
beginRetrieveContinuousBackupInformationAndWait(string, string, string, string, ContinuousBackupRestoreLocation, MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams)
检索 Mongodb 集合的连续备份信息。
function beginRetrieveContinuousBackupInformationAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, location: ContinuousBackupRestoreLocation, options?: MongoDBResourcesRetrieveContinuousBackupInformationOptionalParams): Promise<BackupInformation>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- location
- ContinuousBackupRestoreLocation
连续备份还原位置的名称。
返回
Promise<BackupInformation>
beginUpdateMongoDBCollectionThroughput(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)
更新 Azure Cosmos DB MongoDB 集合每秒 RU 数
function beginUpdateMongoDBCollectionThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要为当前 MongoDB 集合提供的参数每秒 RU 数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginUpdateMongoDBCollectionThroughputAndWait(string, string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams)
更新 Azure Cosmos DB MongoDB 集合每秒 RU 数
function beginUpdateMongoDBCollectionThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBCollectionThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要为当前 MongoDB 集合提供的参数每秒 RU 数。
返回
Promise<ThroughputSettingsGetResults>
beginUpdateMongoDBDatabaseThroughput(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)
更新 Azure Cosmos DB MongoDB 数据库的每秒 RU 数
function beginUpdateMongoDBDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams): Promise<SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要为当前 MongoDB 数据库提供的参数每秒 RU 数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ThroughputSettingsGetResults>, ThroughputSettingsGetResults>>
beginUpdateMongoDBDatabaseThroughputAndWait(string, string, string, ThroughputSettingsUpdateParameters, MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams)
更新 Azure Cosmos DB MongoDB 数据库的每秒 RU 数
function beginUpdateMongoDBDatabaseThroughputAndWait(resourceGroupName: string, accountName: string, databaseName: string, updateThroughputParameters: ThroughputSettingsUpdateParameters, options?: MongoDBResourcesUpdateMongoDBDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- updateThroughputParameters
- ThroughputSettingsUpdateParameters
要为当前 MongoDB 数据库提供的参数每秒 RU 数。
返回
Promise<ThroughputSettingsGetResults>
getMongoDBCollection(string, string, string, string, MongoDBResourcesGetMongoDBCollectionOptionalParams)
获取现有 Azure Cosmos DB 数据库帐户下的 MongoDB 集合。
function getMongoDBCollection(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesGetMongoDBCollectionOptionalParams): Promise<MongoDBCollectionGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
选项参数。
返回
Promise<MongoDBCollectionGetResults>
getMongoDBCollectionThroughput(string, string, string, string, MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams)
获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下的 MongoDB 集合每秒 RU 数。
function getMongoDBCollectionThroughput(resourceGroupName: string, accountName: string, databaseName: string, collectionName: string, options?: MongoDBResourcesGetMongoDBCollectionThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
- collectionName
-
string
Cosmos DB 集合名称。
返回
Promise<ThroughputSettingsGetResults>
getMongoDBDatabase(string, string, string, MongoDBResourcesGetMongoDBDatabaseOptionalParams)
获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下的 MongoDB 数据库。
function getMongoDBDatabase(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesGetMongoDBDatabaseOptionalParams): Promise<MongoDBDatabaseGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
选项参数。
返回
Promise<MongoDBDatabaseGetResults>
getMongoDBDatabaseThroughput(string, string, string, MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams)
获取具有提供名称的现有 Azure Cosmos DB 数据库帐户下的 MongoDB 数据库的每秒 RU 数。
function getMongoDBDatabaseThroughput(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesGetMongoDBDatabaseThroughputOptionalParams): Promise<ThroughputSettingsGetResults>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
返回
Promise<ThroughputSettingsGetResults>
getMongoRoleDefinition(string, string, string, MongoDBResourcesGetMongoRoleDefinitionOptionalParams)
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 角色定义的属性。
function getMongoRoleDefinition(mongoRoleDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesGetMongoRoleDefinitionOptionalParams): Promise<MongoRoleDefinitionGetResults>
参数
- mongoRoleDefinitionId
-
string
角色定义 {dbName.roleName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<MongoRoleDefinitionGetResults>
getMongoUserDefinition(string, string, string, MongoDBResourcesGetMongoUserDefinitionOptionalParams)
检索具有给定 ID 的现有 Azure Cosmos DB Mongo 用户定义的属性。
function getMongoUserDefinition(mongoUserDefinitionId: string, resourceGroupName: string, accountName: string, options?: MongoDBResourcesGetMongoUserDefinitionOptionalParams): Promise<MongoUserDefinitionGetResults>
参数
- mongoUserDefinitionId
-
string
用户定义 {dbName.userName} 的 ID。
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
Promise<MongoUserDefinitionGetResults>
listMongoDBCollections(string, string, string, MongoDBResourcesListMongoDBCollectionsOptionalParams)
列出现有 Azure Cosmos DB 数据库帐户下的 MongoDB 集合。
function listMongoDBCollections(resourceGroupName: string, accountName: string, databaseName: string, options?: MongoDBResourcesListMongoDBCollectionsOptionalParams): PagedAsyncIterableIterator<MongoDBCollectionGetResults, MongoDBCollectionGetResults[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
- databaseName
-
string
Cosmos DB 数据库名称。
选项参数。
返回
listMongoDBDatabases(string, string, MongoDBResourcesListMongoDBDatabasesOptionalParams)
列出现有 Azure Cosmos DB 数据库帐户下的 MongoDB 数据库。
function listMongoDBDatabases(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoDBDatabasesOptionalParams): PagedAsyncIterableIterator<MongoDBDatabaseGetResults, MongoDBDatabaseGetResults[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
listMongoRoleDefinitions(string, string, MongoDBResourcesListMongoRoleDefinitionsOptionalParams)
检索所有 Azure Cosmos DB Mongo 角色定义的列表。
function listMongoRoleDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoRoleDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoRoleDefinitionGetResults, MongoRoleDefinitionGetResults[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。
返回
listMongoUserDefinitions(string, string, MongoDBResourcesListMongoUserDefinitionsOptionalParams)
检索所有 Azure Cosmos DB Mongo 用户定义的列表。
function listMongoUserDefinitions(resourceGroupName: string, accountName: string, options?: MongoDBResourcesListMongoUserDefinitionsOptionalParams): PagedAsyncIterableIterator<MongoUserDefinitionGetResults, MongoUserDefinitionGetResults[], PageSettings>
参数
- resourceGroupName
-
string
资源组的名称。 名称不区分大小写。
- accountName
-
string
Cosmos DB 数据库帐户名称。
选项参数。