MongoClustersOperations interface

包:

@azure/arm-mongocluster

表示 MongoClusters作的接口。

属性

checkNameAvailability	检查 Mongo 群集名称是否可用。
createOrUpdate	创建或更新 mongo 群集。 更新将覆盖资源的所有属性。 若要仅修改某些属性，请使用 PATCH。
delete
get	获取有关 mongo 群集的信息。
list	列出给定订阅中的所有 mongo 群集。
listByResourceGroup	列出给定资源组中的所有 mongo 群集。
listConnectionStrings	列出 mongo 群集连接字符串。 这包括使用 SCRAM-SHA-256 的默认连接字符串，以及群集支持的其他连接字符串。
promote	将副本 mongo 群集提升为主要角色。
update	更新现有的 mongo 群集。 请求正文可以包含普通 mongo 群集定义中存在的一对多属性。

属性详细信息

checkNameAvailability

检查 Mongo 群集名称是否可用。

checkNameAvailability: (location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>

属性值

(location: string, body: CheckNameAvailabilityRequest, options?: MongoClustersCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>

createOrUpdate

创建或更新 mongo 群集。 更新将覆盖资源的所有属性。 若要仅修改某些属性，请使用 PATCH。

createOrUpdate: (resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

属性值

(resourceGroupName: string, mongoClusterName: string, resource: MongoCluster, options?: MongoClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

delete

delete: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

属性值

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

获取有关 mongo 群集的信息。

get: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>

属性值

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersGetOptionalParams) => Promise<MongoCluster>

list

列出给定订阅中的所有 mongo 群集。

list: (options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

属性值

(options?: MongoClustersListOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

listByResourceGroup

列出给定资源组中的所有 mongo 群集。

listByResourceGroup: (resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

属性值

(resourceGroupName: string, options?: MongoClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MongoCluster, MongoCluster[], PageSettings>

listConnectionStrings

列出 mongo 群集连接字符串。 这包括使用 SCRAM-SHA-256 的默认连接字符串，以及群集支持的其他连接字符串。

listConnectionStrings: (resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>

属性值

(resourceGroupName: string, mongoClusterName: string, options?: MongoClustersListConnectionStringsOptionalParams) => Promise<ListConnectionStringsResult>

promote

将副本 mongo 群集提升为主要角色。

promote: (resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>

属性值

(resourceGroupName: string, mongoClusterName: string, body: PromoteReplicaRequest, options?: MongoClustersPromoteOptionalParams) => PollerLike<OperationState<void>, void>

update

更新现有的 mongo 群集。 请求正文可以包含普通 mongo 群集定义中存在的一对多属性。

update: (resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>

属性值

(resourceGroupName: string, mongoClusterName: string, properties: MongoClusterUpdate, options?: MongoClustersUpdateOptionalParams) => PollerLike<OperationState<MongoCluster>, MongoCluster>