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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
Promise<void>
beginPromoteReadReplica(string, string, ClustersPromoteReadReplicaOptionalParams)
読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格します。
function beginPromoteReadReplica(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams): Promise<SimplePollerLike<OperationState<ClustersPromoteReadReplicaHeaders>, ClustersPromoteReadReplicaHeaders>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
クラスターの名前です。
options パラメーター。
戻り値
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 パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
Promise<void>
beginUpdate(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)
既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。
function beginUpdate(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
クラスターの名前です。
- parameters
- ClusterForUpdate
クラスターを更新するためのパラメーター。
- options
- ClustersUpdateOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<Cluster>, Cluster>>
beginUpdateAndWait(string, string, ClusterForUpdate, ClustersUpdateOptionalParams)
既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams): Promise<Cluster>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
クラスターの名前です。
- parameters
- ClusterForUpdate
クラスターを更新するためのパラメーター。
- options
- ClustersUpdateOptionalParams
options パラメーター。
戻り値
Promise<Cluster>
checkNameAvailability(NameAvailabilityRequest, ClustersCheckNameAvailabilityOptionalParams)
クラスター名の可用性を確認します。 クラスター名はグローバルに一意である必要があります。少なくとも 3 文字、最大 40 文字。小文字、数字、ハイフンのみを含める必要があります。と は、ハイフンで開始または終了することはできません。
function checkNameAvailability(nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams): Promise<NameAvailability>パラメーター
- nameAvailabilityRequest
- NameAvailabilityRequest
クラスター名が使用可能かどうかを確認するために必要なパラメーター。
options パラメーター。
戻り値
Promise<NameAvailability>
get(string, string, ClustersGetOptionalParams)
コンピューティングやストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。
function get(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- clusterName
-
string
クラスターの名前です。
- options
- ClustersGetOptionalParams
options パラメーター。
戻り値
Promise<Cluster>
list(ClustersListOptionalParams)
サブスクリプション内のすべてのクラスターを一覧表示します。
function list(options?: ClustersListOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>パラメーター
- options
- ClustersListOptionalParams
options パラメーター。
戻り値
listByResourceGroup(string, ClustersListByResourceGroupOptionalParams)
リソース グループ内のすべてのクラスターを一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
options パラメーター。