ClustersOperations interface
クラスタ操作を表すインターフェイス。
プロパティ
| check |
クラスター名の可用性を確認します。 クラスター名はグローバルに一意である必要があります。3 文字以上、最大 40 文字小文字、数字、ハイフンのみを含める必要があります。で始まるか、ハイフンで終わる必要はありません。 |
| create | サーバーを含む新しいクラスターを作成します。 |
| delete | クラスターをサーバーと共に削除します。 |
| get | コンピューティングとストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。 |
| list | サブスクリプション内のすべてのクラスターを一覧表示します。 |
| list |
リソース グループ内のすべてのクラスターを一覧表示します。 |
| promote |
読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格させます。 |
| restart | クラスター内のすべてのノードを再起動します。 |
| start | すべてのクラスター ノードで停止コンピューティングを開始します。 |
| stop | すべてのクラスター ノードでコンピューティングを停止します。 |
| update | 既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。 |
プロパティの詳細
checkNameAvailability
クラスター名の可用性を確認します。 クラスター名はグローバルに一意である必要があります。3 文字以上、最大 40 文字小文字、数字、ハイフンのみを含める必要があります。で始まるか、ハイフンで終わる必要はありません。
checkNameAvailability: (nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams) => Promise<NameAvailability>
プロパティ値
(nameAvailabilityRequest: NameAvailabilityRequest, options?: ClustersCheckNameAvailabilityOptionalParams) => Promise<NameAvailability>
create
サーバーを含む新しいクラスターを作成します。
create: (resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>
プロパティ値
(resourceGroupName: string, clusterName: string, parameters: Cluster, options?: ClustersCreateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>
delete
クラスターをサーバーと共に削除します。
delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>
get
コンピューティングとストレージの構成などのクラスターに関する情報と、クラスターの作成日時などのクラスター ライフサイクル メタデータを取得します。
get: (resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams) => Promise<Cluster>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams) => Promise<Cluster>
list
サブスクリプション内のすべてのクラスターを一覧表示します。
list: (options?: ClustersListOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
プロパティ値
(options?: ClustersListOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
listByResourceGroup
リソース グループ内のすべてのクラスターを一覧表示します。
listByResourceGroup: (resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
プロパティ値
(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>
promoteReadReplica
読み取りレプリカ クラスターを独立した読み取り/書き込みクラスターに昇格させます。
promoteReadReplica: (resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams) => PollerLike<OperationState<void>, void>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersPromoteReadReplicaOptionalParams) => PollerLike<OperationState<void>, void>
restart
クラスター内のすべてのノードを再起動します。
restart: (resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams) => PollerLike<OperationState<void>, void>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersRestartOptionalParams) => PollerLike<OperationState<void>, void>
start
すべてのクラスター ノードで停止コンピューティングを開始します。
start: (resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersStartOptionalParams) => PollerLike<OperationState<void>, void>
stop
すべてのクラスター ノードでコンピューティングを停止します。
stop: (resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>
プロパティ値
(resourceGroupName: string, clusterName: string, options?: ClustersStopOptionalParams) => PollerLike<OperationState<void>, void>
update
既存のクラスターを更新します。 要求本文には、クラスター定義の 1 つまたは複数のプロパティを含めることができます。
update: (resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>
プロパティ値
(resourceGroupName: string, clusterName: string, parameters: ClusterForUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>