CassandraClusters interface

パッケージ:

@azure/arm-cosmosdb

CassandraClusters を表すインターフェイス。

メソッド

beginCreateUpdate(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)	マネージド Cassandra クラスターを作成または更新します。 更新するときは、すべての書き込み可能なプロパティを指定する必要があります。 一部のプロパティのみを更新するには、PATCH を使用します。
beginCreateUpdateAndWait(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)	マネージド Cassandra クラスターを作成または更新します。 更新するときは、すべての書き込み可能なプロパティを指定する必要があります。 一部のプロパティのみを更新するには、PATCH を使用します。
beginDeallocate(string, string, CassandraClustersDeallocateOptionalParams)	マネージド Cassandra クラスターと関連するデータ センターの割り当てを解除します。 割り当てを解除すると、このクラスターのホスト仮想マシンの割り当てが解除され、データ ディスクが予約されます。 これにより、既に割り当て解除されたクラスターでは何も行われません。 [開始] を使用してクラスターを再起動します。
beginDeallocateAndWait(string, string, CassandraClustersDeallocateOptionalParams)	マネージド Cassandra クラスターと関連するデータ センターの割り当てを解除します。 割り当てを解除すると、このクラスターのホスト仮想マシンの割り当てが解除され、データ ディスクが予約されます。 これにより、既に割り当て解除されたクラスターでは何も行われません。 [開始] を使用してクラスターを再起動します。
beginDelete(string, string, CassandraClustersDeleteOptionalParams)	マネージド Cassandra クラスターを削除します。
beginDeleteAndWait(string, string, CassandraClustersDeleteOptionalParams)	マネージド Cassandra クラスターを削除します。
beginInvokeCommand(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)	cassandra メンテナンスのために nodetool などのコマンドを呼び出す
beginInvokeCommandAndWait(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)	cassandra メンテナンスのために nodetool などのコマンドを呼び出す
beginStart(string, string, CassandraClustersStartOptionalParams)	マネージド Cassandra クラスターと関連するデータ センターを開始します。 開始すると、予約済みデータ ディスクを使用して、このクラスターのホスト仮想マシンが起動します。 これは、既に実行されているクラスターでは何も行われません。 [割り当て解除] を使用してクラスターの割り当てを解除します。
beginStartAndWait(string, string, CassandraClustersStartOptionalParams)	マネージド Cassandra クラスターと関連するデータ センターを開始します。 開始すると、予約済みデータ ディスクを使用して、このクラスターのホスト仮想マシンが起動します。 これは、既に実行されているクラスターでは何も行われません。 [割り当て解除] を使用してクラスターの割り当てを解除します。
beginUpdate(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)	マネージド Cassandra クラスターのプロパティの一部を更新します。
beginUpdateAndWait(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)	マネージド Cassandra クラスターのプロパティの一部を更新します。
get(string, string, CassandraClustersGetOptionalParams)	マネージド Cassandra クラスターのプロパティを取得します。
listByResourceGroup(string, CassandraClustersListByResourceGroupOptionalParams)	このリソース グループ内のすべてのマネージド Cassandra クラスターを一覧表示します。
listBySubscription(CassandraClustersListBySubscriptionOptionalParams)	このサブスクリプション内のすべてのマネージド Cassandra クラスターを一覧表示します。
status(string, string, CassandraClustersStatusOptionalParams)	クラスター内の各 Cassandra ノードの CPU、メモリ、およびディスク使用量の統計情報を取得します。

メソッドの詳細

beginCreateUpdate(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)

マネージド Cassandra クラスターを作成または更新します。 更新するときは、すべての書き込み可能なプロパティを指定する必要があります。 一部のプロパティのみを更新するには、PATCH を使用します。

function beginCreateUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

ClusterResource

マネージド Cassandra クラスターの目的の状態を指定するプロパティ。

options

CassandraClustersCreateUpdateOptionalParams

options パラメーター。

戻り値

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

beginCreateUpdateAndWait(string, string, ClusterResource, CassandraClustersCreateUpdateOptionalParams)

マネージド Cassandra クラスターを作成または更新します。 更新するときは、すべての書き込み可能なプロパティを指定する必要があります。 一部のプロパティのみを更新するには、PATCH を使用します。

function beginCreateUpdateAndWait(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersCreateUpdateOptionalParams): Promise<ClusterResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

ClusterResource

マネージド Cassandra クラスターの目的の状態を指定するプロパティ。

options

CassandraClustersCreateUpdateOptionalParams

options パラメーター。

戻り値

Promise<ClusterResource>

beginDeallocate(string, string, CassandraClustersDeallocateOptionalParams)

マネージド Cassandra クラスターと関連するデータ センターの割り当てを解除します。 割り当てを解除すると、このクラスターのホスト仮想マシンの割り当てが解除され、データ ディスクが予約されます。 これにより、既に割り当て解除されたクラスターでは何も行われません。 [開始] を使用してクラスターを再起動します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersDeallocateOptionalParams

options パラメーター。

戻り値

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

beginDeallocateAndWait(string, string, CassandraClustersDeallocateOptionalParams)

マネージド Cassandra クラスターと関連するデータ センターの割り当てを解除します。 割り当てを解除すると、このクラスターのホスト仮想マシンの割り当てが解除され、データ ディスクが予約されます。 これにより、既に割り当て解除されたクラスターでは何も行われません。 [開始] を使用してクラスターを再起動します。

function beginDeallocateAndWait(resourceGroupName: string, clusterName: string, options?: CassandraClustersDeallocateOptionalParams): Promise<void>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersDeallocateOptionalParams

options パラメーター。

戻り値

Promise<void>

beginDelete(string, string, CassandraClustersDeleteOptionalParams)

マネージド Cassandra クラスターを削除します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersDeleteOptionalParams

options パラメーター。

戻り値

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

beginDeleteAndWait(string, string, CassandraClustersDeleteOptionalParams)

マネージド Cassandra クラスターを削除します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersDeleteOptionalParams

options パラメーター。

戻り値

Promise<void>

beginInvokeCommand(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)

cassandra メンテナンスのために nodetool などのコマンドを呼び出す

function beginInvokeCommand(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams): Promise<SimplePollerLike<OperationState<CommandOutput>, CommandOutput>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

CommandPostBody

実行するコマンドを指定する場所

options

CassandraClustersInvokeCommandOptionalParams

options パラメーター。

戻り値

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

beginInvokeCommandAndWait(string, string, CommandPostBody, CassandraClustersInvokeCommandOptionalParams)

cassandra メンテナンスのために nodetool などのコマンドを呼び出す

function beginInvokeCommandAndWait(resourceGroupName: string, clusterName: string, body: CommandPostBody, options?: CassandraClustersInvokeCommandOptionalParams): Promise<CommandOutput>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

CommandPostBody

実行するコマンドを指定する場所

options

CassandraClustersInvokeCommandOptionalParams

options パラメーター。

戻り値

Promise<CommandOutput>

beginStart(string, string, CassandraClustersStartOptionalParams)

マネージド Cassandra クラスターと関連するデータ センターを開始します。 開始すると、予約済みデータ ディスクを使用して、このクラスターのホスト仮想マシンが起動します。 これは、既に実行されているクラスターでは何も行われません。 [割り当て解除] を使用してクラスターの割り当てを解除します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersStartOptionalParams

options パラメーター。

戻り値

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

beginStartAndWait(string, string, CassandraClustersStartOptionalParams)

マネージド Cassandra クラスターと関連するデータ センターを開始します。 開始すると、予約済みデータ ディスクを使用して、このクラスターのホスト仮想マシンが起動します。 これは、既に実行されているクラスターでは何も行われません。 [割り当て解除] を使用してクラスターの割り当てを解除します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersStartOptionalParams

options パラメーター。

戻り値

Promise<void>

beginUpdate(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)

マネージド Cassandra クラスターのプロパティの一部を更新します。

function beginUpdate(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ClusterResource>, ClusterResource>>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

ClusterResource

マネージド Cassandra クラスターを指定するために指定するパラメーター。

options

CassandraClustersUpdateOptionalParams

options パラメーター。

戻り値

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

beginUpdateAndWait(string, string, ClusterResource, CassandraClustersUpdateOptionalParams)

マネージド Cassandra クラスターのプロパティの一部を更新します。

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, body: ClusterResource, options?: CassandraClustersUpdateOptionalParams): Promise<ClusterResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

body

ClusterResource

マネージド Cassandra クラスターを指定するために指定するパラメーター。

options

CassandraClustersUpdateOptionalParams

options パラメーター。

戻り値

Promise<ClusterResource>

get(string, string, CassandraClustersGetOptionalParams)

マネージド Cassandra クラスターのプロパティを取得します。

function get(resourceGroupName: string, clusterName: string, options?: CassandraClustersGetOptionalParams): Promise<ClusterResource>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersGetOptionalParams

options パラメーター。

戻り値

Promise<ClusterResource>

listByResourceGroup(string, CassandraClustersListByResourceGroupOptionalParams)

このリソース グループ内のすべてのマネージド Cassandra クラスターを一覧表示します。

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

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

options

CassandraClustersListByResourceGroupOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

listBySubscription(CassandraClustersListBySubscriptionOptionalParams)

このサブスクリプション内のすべてのマネージド Cassandra クラスターを一覧表示します。

function listBySubscription(options?: CassandraClustersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

パラメーター

options

CassandraClustersListBySubscriptionOptionalParams

options パラメーター。

戻り値

PagedAsyncIterableIterator<ClusterResource, ClusterResource[], PageSettings>

status(string, string, CassandraClustersStatusOptionalParams)

クラスター内の各 Cassandra ノードの CPU、メモリ、およびディスク使用量の統計情報を取得します。

function status(resourceGroupName: string, clusterName: string, options?: CassandraClustersStatusOptionalParams): Promise<CassandraClusterPublicStatus>

パラメーター

resourceGroupName

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

clusterName

string

マネージド Cassandra クラスター名。

options

CassandraClustersStatusOptionalParams

options パラメーター。

戻り値

Promise<CassandraClusterPublicStatus>