Clusters interface
表示叢集的介面。
方法
方法詳細資料
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
叢集的名稱。
選項參數。
傳回
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
叢集的名稱。
選項參數。
傳回
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
檢查叢集名稱是否可用的必要參數。
選項參數。
傳回
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
選項參數。
傳回
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
列出資源群組中的所有叢集。
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
選項參數。