你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Clusters interface

包:: @azure/arm-cosmosdbforpostgresql

表示群集的接口。

方法

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)	使用服务器创建新群集。
beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)	使用服务器创建新群集。
beginDelete(string, string, ClustersDeleteOptionalParams)	将群集与其中的服务器一起删除。
beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)	将群集与其中的服务器一起删除。
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)	将只读副本群集提升为独立的读写群集。
beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)	将只读副本群集提升为独立的读写群集。
beginRestart(string, string, ClustersRestartOptionalParams)	重启群集中的所有节点。
beginRestartAndWait(string, string, ClustersRestartOptionalParams)	重启群集中的所有节点。
beginStart(string, string, ClustersStartOptionalParams)	在所有群集节点上启动停止计算。
beginStartAndWait(string, string, ClustersStartOptionalParams)	在所有群集节点上启动停止计算。
beginStop(string, string, ClustersStopOptionalParams)	停止所有群集节点上的计算。
beginStopAndWait(string, string, ClustersStopOptionalParams)	停止所有群集节点上的计算。
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	更新现有群集。请求正文可以包含群集定义的一个或多个属性。
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)	更新现有群集。请求正文可以包含群集定义的一个或多个属性。
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)	检查群集名称的可用性。群集名称应全局唯一;至少 3 个字符，最多 40 个字符;它们必须仅包含小写字母、数字和连字符;不得以连字符开头或结尾。
get(string, string, ClustersGetOptionalParams)	获取有关群集的信息，例如计算和存储配置以及群集生命周期元数据，例如群集创建日期和时间。
list(ClustersListOptionalParams)	列出订阅中的所有群集。
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)	列出资源组中的所有群集。

方法详细信息

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

使用服务器创建新群集。

function beginCreate(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

parameters: Cluster

创建或更新群集所需的参数。

options: ClustersCreateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

使用服务器创建新群集。

function beginCreateAndWait(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams): Promise<Cluster>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

parameters: Cluster

创建或更新群集所需的参数。

options: ClustersCreateOptionalParams

选项参数。

Promise<Cluster>

beginDelete(string, string, ClustersDeleteOptionalParams)

将群集与其中的服务器一起删除。

function beginDelete(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersDeleteOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

将群集与其中的服务器一起删除。

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersDeleteOptionalParams

选项参数。

Promise<void>

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

将只读副本群集提升为独立的读写群集。

function beginPromoteReadReplica(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersPromoteReadReplicaOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

将只读副本群集提升为独立的读写群集。

function beginPromoteReadReplicaAndWait(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<ClustersPromoteReadReplicaHeaders>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersPromoteReadReplicaOptionalParams

选项参数。

Promise<ClustersPromoteReadReplicaHeaders>

beginRestart(string, string, ClustersRestartOptionalParams)

重启群集中的所有节点。

function beginRestart(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersRestartOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<ClustersRestartHeaders>, ClustersRestartHeaders>>

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

重启群集中的所有节点。

function beginRestartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams): Promise<ClustersRestartHeaders>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersRestartOptionalParams

选项参数。

Promise<ClustersRestartHeaders>

beginStart(string, string, ClustersStartOptionalParams)

在所有群集节点上启动停止计算。

function beginStart(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersStartOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ClustersStartOptionalParams)

在所有群集节点上启动停止计算。

function beginStartAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersStartOptionalParams

选项参数。

Promise<void>

beginStop(string, string, ClustersStopOptionalParams)

停止所有群集节点上的计算。

function beginStop(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersStopOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStopAndWait(string, string, ClustersStopOptionalParams)

停止所有群集节点上的计算。

function beginStopAndWait(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams): Promise<void>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersStopOptionalParams

选项参数。

Promise<void>

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

更新现有群集。请求正文可以包含群集定义的一个或多个属性。

function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

parameters: ClusterForUpdate

用于更新群集的参数。

options: ClustersUpdateOptionalParams

选项参数。

Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

更新现有群集。请求正文可以包含群集定义的一个或多个属性。

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

parameters: ClusterForUpdate

用于更新群集的参数。

options: ClustersUpdateOptionalParams

选项参数。

Promise<Cluster>

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

检查群集名称的可用性。群集名称应全局唯一;至少 3 个字符，最多 40 个字符;它们必须仅包含小写字母、数字和连字符;不得以连字符开头或结尾。

function checkNameAvailability(nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams): Promise<NameAvailability>

参数

nameAvailabilityRequest: NameAvailabilityRequest

用于检查群集名称是否可用所需的参数。

options: ClustersCheckNameAvailabilityOptionalParams

选项参数。

Promise<NameAvailability>

get(string, string, ClustersGetOptionalParams)

获取有关群集的信息，例如计算和存储配置以及群集生命周期元数据，例如群集创建日期和时间。

function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

clusterName: string

群集的名称。

options: ClustersGetOptionalParams

选项参数。

Promise<Cluster>

list(ClustersListOptionalParams)

列出订阅中的所有群集。

function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

参数

options: ClustersListOptionalParams

选项参数。

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

参数

resourceGroupName: string

资源组的名称。名称不区分大小写。

options: ClustersListByResourceGroupOptionalParams

选项参数。

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

通过

Clusters interface

方法

方法详细信息

beginCreate(string, string, Cluster, ClustersCreateOptionalParams)

参数

返回

beginCreateAndWait(string, string, Cluster, ClustersCreateOptionalParams)

参数

返回

beginDelete(string, string, ClustersDeleteOptionalParams)

参数

返回

beginDeleteAndWait(string, string, ClustersDeleteOptionalParams)

参数

返回

beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)

参数

返回

beginPromoteReadReplicaAndWait(string, string, ClustersPromoteReadReplicaOptionalParams)

参数

返回

beginRestart(string, string, ClustersRestartOptionalParams)

参数

返回

beginRestartAndWait(string, string, ClustersRestartOptionalParams)

参数

返回

beginStart(string, string, ClustersStartOptionalParams)

参数

返回

beginStartAndWait(string, string, ClustersStartOptionalParams)

参数

返回

beginStop(string, string, ClustersStopOptionalParams)

参数

返回

beginStopAndWait(string, string, ClustersStopOptionalParams)

参数

返回

beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

参数

返回

beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)

参数

返回

checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)

参数

返回

get(string, string, ClustersGetOptionalParams)

参数

返回

list(ClustersListOptionalParams)

参数

返回

listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)

参数

返回