Package version:

Interface Clusters

Interface representing a Clusters.

interface Clusters {
    beginCreate(resourceGroupName: string, clusterPoolName: string, clusterName: string, hDInsightCluster: Cluster, options?: ClustersCreateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginCreateAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, hDInsightCluster: Cluster, options?: ClustersCreateOptionalParams): Promise<Cluster>;
    beginDelete(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersDeleteOptionalParams): Promise<void>;
    beginResize(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginResizeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterResizeRequest: ClusterResizeData, options?: ClustersResizeOptionalParams): Promise<Cluster>;
    beginUpdate(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginUpdateAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterPatchRequest: ClusterPatch, options?: ClustersUpdateOptionalParams): Promise<Cluster>;
    beginUpgrade(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginUpgradeAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterUpgradeRequest: ClusterUpgrade, options?: ClustersUpgradeOptionalParams): Promise<Cluster>;
    beginUpgradeManualRollback(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>;
    beginUpgradeManualRollbackAndWait(resourceGroupName: string, clusterPoolName: string, clusterName: string, clusterRollbackUpgradeRequest: ClusterUpgradeRollback, options?: ClustersUpgradeManualRollbackOptionalParams): Promise<Cluster>;
    get(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersGetOptionalParams): Promise<Cluster>;
    getInstanceView(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersGetInstanceViewOptionalParams): Promise<ClusterInstanceViewResult>;
    listByClusterPoolName(resourceGroupName: string, clusterPoolName: string, options?: ClustersListByClusterPoolNameOptionalParams): PagedAsyncIterableIterator<Cluster>;
    listInstanceViews(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListInstanceViewsOptionalParams): PagedAsyncIterableIterator<ClusterInstanceViewResult>;
    listServiceConfigs(resourceGroupName: string, clusterPoolName: string, clusterName: string, options?: ClustersListServiceConfigsOptionalParams): PagedAsyncIterableIterator<ServiceConfigResult>;
}

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginResize beginResizeAndWait beginUpdate beginUpdateAndWait beginUpgrade beginUpgradeAndWait beginUpgradeManualRollback beginUpgradeManualRollbackAndWait get getInstanceView listByClusterPoolName listInstanceViews listServiceConfigs

Methods

beginCreate

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

  • Creates a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • hDInsightCluster: Cluster

      The cluster to create.

    • Optionaloptions: ClustersCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateAndWait

  • beginCreateAndWait(resourceGroupName, clusterPoolName, clusterName, hDInsightCluster, options?): Promise<Cluster>

  • Creates a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • hDInsightCluster: Cluster

      The cluster to create.

    • Optionaloptions: ClustersCreateOptionalParams

      The options parameters.

    Returns Promise<Cluster>

beginDelete

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

  • Deletes a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • Optionaloptions: ClustersDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

  • beginDeleteAndWait(resourceGroupName, clusterPoolName, clusterName, options?): Promise<void>

  • Deletes a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • Optionaloptions: ClustersDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

beginResize

  • beginResize(resourceGroupName, clusterPoolName, clusterName, clusterResizeRequest, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • Resize an existing Cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterResizeRequest: ClusterResizeData

      Resize a cluster.

    • Optionaloptions: ClustersResizeOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginResizeAndWait

  • beginResizeAndWait(resourceGroupName, clusterPoolName, clusterName, clusterResizeRequest, options?): Promise<Cluster>

  • Resize an existing Cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterResizeRequest: ClusterResizeData

      Resize a cluster.

    • Optionaloptions: ClustersResizeOptionalParams

      The options parameters.

    Returns Promise<Cluster>

beginUpdate

  • beginUpdate(resourceGroupName, clusterPoolName, clusterName, clusterPatchRequest, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • Updates an existing Cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterPatchRequest: ClusterPatch

      Patch a cluster.

    • Optionaloptions: ClustersUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait

  • beginUpdateAndWait(resourceGroupName, clusterPoolName, clusterName, clusterPatchRequest, options?): Promise<Cluster>

  • Updates an existing Cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterPatchRequest: ClusterPatch

      Patch a cluster.

    • Optionaloptions: ClustersUpdateOptionalParams

      The options parameters.

    Returns Promise<Cluster>

beginUpgrade

  • beginUpgrade(resourceGroupName, clusterPoolName, clusterName, clusterUpgradeRequest, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • Upgrade a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterUpgradeRequest: ClusterUpgrade

      Upgrade a cluster.

    • Optionaloptions: ClustersUpgradeOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpgradeAndWait

  • beginUpgradeAndWait(resourceGroupName, clusterPoolName, clusterName, clusterUpgradeRequest, options?): Promise<Cluster>

  • Upgrade a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterUpgradeRequest: ClusterUpgrade

      Upgrade a cluster.

    • Optionaloptions: ClustersUpgradeOptionalParams

      The options parameters.

    Returns Promise<Cluster>

beginUpgradeManualRollback

  • beginUpgradeManualRollback(resourceGroupName, clusterPoolName, clusterName, clusterRollbackUpgradeRequest, options?): Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

  • Manual rollback upgrade for a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterRollbackUpgradeRequest: ClusterUpgradeRollback

      Manual rollback upgrade for a cluster.

    • Optionaloptions: ClustersUpgradeManualRollbackOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpgradeManualRollbackAndWait

  • beginUpgradeManualRollbackAndWait(resourceGroupName, clusterPoolName, clusterName, clusterRollbackUpgradeRequest, options?): Promise<Cluster>

  • Manual rollback upgrade for a cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • clusterRollbackUpgradeRequest: ClusterUpgradeRollback

      Manual rollback upgrade for a cluster.

    • Optionaloptions: ClustersUpgradeManualRollbackOptionalParams

      The options parameters.

    Returns Promise<Cluster>

get

  • get(resourceGroupName, clusterPoolName, clusterName, options?): Promise<Cluster>

  • Gets a HDInsight cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • Optionaloptions: ClustersGetOptionalParams

      The options parameters.

    Returns Promise<Cluster>

getInstanceView

listByClusterPoolName

  • listByClusterPoolName(resourceGroupName, clusterPoolName, options?): PagedAsyncIterableIterator<Cluster>

  • Lists the HDInsight cluster pools under a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • Optionaloptions: ClustersListByClusterPoolNameOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<Cluster>

listInstanceViews

listServiceConfigs

  • listServiceConfigs(resourceGroupName, clusterPoolName, clusterName, options?): PagedAsyncIterableIterator<ServiceConfigResult>

  • Lists the config dump of all services running in cluster.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • clusterPoolName: string

      The name of the cluster pool.

    • clusterName: string

      The name of the HDInsight cluster.

    • Optionaloptions: ClustersListServiceConfigsOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ServiceConfigResult>

Settings

Member Visibility