Interface Clusters

public interface Clusters
Resource collection API of Clusters.

  • Method Details

    • listByClusterPoolName

      com.azure.core.http.rest.PagedIterable<Cluster> listByClusterPoolName(String resourceGroupName, String clusterPoolName)
      Lists the HDInsight cluster pools under a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      Returns:
      the list cluster operation response as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByClusterPoolName

      com.azure.core.http.rest.PagedIterable<Cluster> listByClusterPoolName(String resourceGroupName, String clusterPoolName, com.azure.core.util.Context context)
      Lists the HDInsight cluster pools under a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      context - The context to associate with this operation.
      Returns:
      the list cluster operation response as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgrade

      Cluster upgrade(String resourceGroupName, String clusterPoolName, String clusterName, ClusterUpgrade clusterUpgradeRequest)
      Upgrade a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterUpgradeRequest - Upgrade a cluster.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgrade

      Cluster upgrade(String resourceGroupName, String clusterPoolName, String clusterName, ClusterUpgrade clusterUpgradeRequest, com.azure.core.util.Context context)
      Upgrade a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterUpgradeRequest - Upgrade a cluster.
      context - The context to associate with this operation.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgradeManualRollback

      Cluster upgradeManualRollback(String resourceGroupName, String clusterPoolName, String clusterName, ClusterUpgradeRollback clusterRollbackUpgradeRequest)
      Manual rollback upgrade for a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterRollbackUpgradeRequest - Manual rollback upgrade for a cluster.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgradeManualRollback

      Cluster upgradeManualRollback(String resourceGroupName, String clusterPoolName, String clusterName, ClusterUpgradeRollback clusterRollbackUpgradeRequest, com.azure.core.util.Context context)
      Manual rollback upgrade for a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterRollbackUpgradeRequest - Manual rollback upgrade for a cluster.
      context - The context to associate with this operation.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resize

      Cluster resize(String resourceGroupName, String clusterPoolName, String clusterName, ClusterResizeData clusterResizeRequest)
      Resize an existing Cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterResizeRequest - Resize a cluster.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resize

      Cluster resize(String resourceGroupName, String clusterPoolName, String clusterName, ClusterResizeData clusterResizeRequest, com.azure.core.util.Context context)
      Resize an existing Cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      clusterResizeRequest - Resize a cluster.
      context - The context to associate with this operation.
      Returns:
      the cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<Cluster> getWithResponse(String resourceGroupName, String clusterPoolName, String clusterName, com.azure.core.util.Context context)
      Gets a HDInsight cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      context - The context to associate with this operation.
      Returns:
      a HDInsight cluster along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      Cluster get(String resourceGroupName, String clusterPoolName, String clusterName)
      Gets a HDInsight cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      Returns:
      a HDInsight cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String clusterPoolName, String clusterName)
      Deletes a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String clusterPoolName, String clusterName, com.azure.core.util.Context context)
      Deletes a cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listServiceConfigs

      com.azure.core.http.rest.PagedIterable<ServiceConfigResult> listServiceConfigs(String resourceGroupName, String clusterPoolName, String clusterName)
      Lists the config dump of all services running in cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      Returns:
      cluster instance service configs api response as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listServiceConfigs

      com.azure.core.http.rest.PagedIterable<ServiceConfigResult> listServiceConfigs(String resourceGroupName, String clusterPoolName, String clusterName, com.azure.core.util.Context context)
      Lists the config dump of all services running in cluster.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      context - The context to associate with this operation.
      Returns:
      cluster instance service configs api response as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listInstanceViews

      com.azure.core.http.rest.PagedIterable<ClusterInstanceViewResult> listInstanceViews(String resourceGroupName, String clusterPoolName, String clusterName)
      Lists the lists of instance views.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      Returns:
      the instance view of a HDInsight Cluster as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listInstanceViews

      com.azure.core.http.rest.PagedIterable<ClusterInstanceViewResult> listInstanceViews(String resourceGroupName, String clusterPoolName, String clusterName, com.azure.core.util.Context context)
      Lists the lists of instance views.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      context - The context to associate with this operation.
      Returns:
      the instance view of a HDInsight Cluster as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getInstanceViewWithResponse

      com.azure.core.http.rest.Response<ClusterInstanceViewResult> getInstanceViewWithResponse(String resourceGroupName, String clusterPoolName, String clusterName, com.azure.core.util.Context context)
      Gets the status of a cluster instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      context - The context to associate with this operation.
      Returns:
      the status of a cluster instance along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getInstanceView

      ClusterInstanceViewResult getInstanceView(String resourceGroupName, String clusterPoolName, String clusterName)
      Gets the status of a cluster instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      clusterPoolName - The name of the cluster pool.
      clusterName - The name of the HDInsight cluster.
      Returns:
      the status of a cluster instance.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      Cluster getById(String id)
      Gets a HDInsight cluster.
      Parameters:
      id - the resource ID.
      Returns:
      a HDInsight cluster along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Cluster> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a HDInsight cluster.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a HDInsight cluster along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

      void deleteById(String id)
      Deletes a cluster.
      Parameters:
      id - the resource ID.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a cluster.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • define

      Cluster.DefinitionStages.Blank define(String name)
      Begins definition for a new Cluster resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Cluster definition.