Clusters interface

パッケージ:

@azure/arm-hdinsightcontainers

クラスターを表すインターフェイス。

メソッド

beginCreate(string, string, string, Cluster, ClustersCreateOptionalParams)	クラスターを作成します。
beginCreateAndWait(string, string, string, Cluster, ClustersCreateOptionalParams)	クラスターを作成します。
beginDelete(string, string, string, ClustersDeleteOptionalParams)	クラスターを削除します。
beginDeleteAndWait(string, string, string, ClustersDeleteOptionalParams)	クラスターを削除します。
beginResize(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)	既存のクラスターのサイズを変更します。
beginResizeAndWait(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)	既存のクラスターのサイズを変更します。
beginUpdate(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)	既存のクラスターを更新します。
beginUpdateAndWait(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)	既存のクラスターを更新します。
beginUpgrade(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)	クラスターをアップグレードします。
beginUpgradeAndWait(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)	クラスターをアップグレードします。
beginUpgradeManualRollback(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)	クラスターの手動ロールバック アップグレード。
beginUpgradeManualRollbackAndWait(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)	クラスターの手動ロールバック アップグレード。
get(string, string, string, ClustersGetOptionalParams)	HDInsight クラスターを取得します。
getInstanceView(string, string, string, ClustersGetInstanceViewOptionalParams)	クラスター インスタンスの状態を取得します。
listByClusterPoolName(string, string, ClustersListByClusterPoolNameOptionalParams)	リソース グループの下にある HDInsight クラスター プールを一覧表示します。
listInstanceViews(string, string, string, ClustersListInstanceViewsOptionalParams)	インスタンス ビューの一覧を一覧表示します
listServiceConfigs(string, string, string, ClustersListServiceConfigsOptionalParams)	クラスターで実行されているすべてのサービスの構成ダンプを一覧表示します。

メソッドの詳細

beginCreate(string, string, string, Cluster, ClustersCreateOptionalParams)

クラスターを作成します。

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

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

hDInsightCluster

Cluster

作成するクラスター。

options

ClustersCreateOptionalParams

オプション パラメーター。

戻り値

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

beginCreateAndWait(string, string, string, Cluster, ClustersCreateOptionalParams)

クラスターを作成します。

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

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

hDInsightCluster

Cluster

作成するクラスター。

options

ClustersCreateOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

beginDelete(string, string, string, ClustersDeleteOptionalParams)

クラスターを削除します。

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

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersDeleteOptionalParams

オプション パラメーター。

戻り値

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

beginDeleteAndWait(string, string, string, ClustersDeleteOptionalParams)

クラスターを削除します。

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

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersDeleteOptionalParams

オプション パラメーター。

戻り値

Promise<void>

beginResize(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)

既存のクラスターのサイズを変更します。

function beginResize(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterResizeRequest

ClusterResizeData

クラスターのサイズを変更します。

options

ClustersResizeOptionalParams

オプション パラメーター。

戻り値

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

beginResizeAndWait(string, string, string, ClusterResizeData, ClustersResizeOptionalParams)

既存のクラスターのサイズを変更します。

function beginResizeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<Cluster>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterResizeRequest

ClusterResizeData

クラスターのサイズを変更します。

options

ClustersResizeOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

beginUpdate(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)

既存のクラスターを更新します。

function beginUpdate(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterPatchRequest

ClusterPatch

クラスターにパッチを適用します。

options

ClustersUpdateOptionalParams

オプション パラメーター。

戻り値

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

beginUpdateAndWait(string, string, string, ClusterPatch, ClustersUpdateOptionalParams)

既存のクラスターを更新します。

function beginUpdateAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<Cluster>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterPatchRequest

ClusterPatch

クラスターにパッチを適用します。

options

ClustersUpdateOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

beginUpgrade(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)

クラスターをアップグレードします。

function beginUpgrade(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterUpgradeRequest

ClusterUpgrade

クラスターをアップグレードします。

options

ClustersUpgradeOptionalParams

オプション パラメーター。

戻り値

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

beginUpgradeAndWait(string, string, string, ClusterUpgrade, ClustersUpgradeOptionalParams)

クラスターをアップグレードします。

function beginUpgradeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<Cluster>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterUpgradeRequest

ClusterUpgrade

クラスターをアップグレードします。

options

ClustersUpgradeOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

beginUpgradeManualRollback(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)

クラスターの手動ロールバック アップグレード。

function beginUpgradeManualRollback(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterRollbackUpgradeRequest

ClusterUpgradeRollback

クラスターの手動ロールバック アップグレード。

options

ClustersUpgradeManualRollbackOptionalParams

オプション パラメーター。

戻り値

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

beginUpgradeManualRollbackAndWait(string, string, string, ClusterUpgradeRollback, ClustersUpgradeManualRollbackOptionalParams)

クラスターの手動ロールバック アップグレード。

function beginUpgradeManualRollbackAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<Cluster>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

clusterRollbackUpgradeRequest

ClusterUpgradeRollback

クラスターの手動ロールバック アップグレード。

options

ClustersUpgradeManualRollbackOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

get(string, string, string, ClustersGetOptionalParams)

HDInsight クラスターを取得します。

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

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersGetOptionalParams

オプション パラメーター。

戻り値

Promise<Cluster>

getInstanceView(string, string, string, ClustersGetInstanceViewOptionalParams)

クラスター インスタンスの状態を取得します。

function getInstanceView(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersGetInstanceViewOptionalParams): Promise<ClusterInstanceViewResult>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersGetInstanceViewOptionalParams

オプション パラメーター。

戻り値

Promise<ClusterInstanceViewResult>

listByClusterPoolName(string, string, ClustersListByClusterPoolNameOptionalParams)

リソース グループの下にある HDInsight クラスター プールを一覧表示します。

function listByClusterPoolName(resourceGroupName: string, clusterPoolName: string, options?: ClustersListByClusterPoolNameOptionalParams): PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

options

ClustersListByClusterPoolNameOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listInstanceViews(string, string, string, ClustersListInstanceViewsOptionalParams)

インスタンス ビューの一覧を一覧表示します

function listInstanceViews(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListInstanceViewsOptionalParams): PagedAsyncIterableIterator<ClusterInstanceViewResult, ClusterInstanceViewResult[], PageSettings>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersListInstanceViewsOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<ClusterInstanceViewResult, ClusterInstanceViewResult[], PageSettings>

listServiceConfigs(string, string, string, ClustersListServiceConfigsOptionalParams)

クラスターで実行されているすべてのサービスの構成ダンプを一覧表示します。

function listServiceConfigs(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListServiceConfigsOptionalParams): PagedAsyncIterableIterator<ServiceConfigResult, ServiceConfigResult[], PageSettings>

パラメーター

resourceGroupName

string

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

clusterPoolName

string

クラスター プールの名前。

clusterName

string

HDInsight クラスターの名前。

options

ClustersListServiceConfigsOptionalParams

オプション パラメーター。

戻り値

PagedAsyncIterableIterator<ServiceConfigResult, ServiceConfigResult[], PageSettings>