azure.mgmt.hdinsight.operations.ClustersOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.hdinsight.operations.ClustersOperations
name: ClustersOperations
fullName: azure.mgmt.hdinsight.operations.ClustersOperations
module: azure.mgmt.hdinsight.operations
inheritances:
- builtins.object
summary: 'ClustersOperations operations.


  You should not instantiate this class directly. Instead, you should create a Client
  instance that

  instantiates it for you and attaches it as an attribute.'
constructor:
  syntax: ClustersOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_create
  name: begin_create
  summary: Creates a new HDInsight cluster with the specified parameters.
  signature: 'begin_create(resource_group_name: str, cluster_name: str, parameters:
    ''_models.ClusterCreateParametersExtended'', **kwargs: Any) -> LROPoller[''_models.Cluster'']'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The cluster create request.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.ClusterCreateParametersExtended>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either Cluster or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.hdinsight.models.Cluster>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_delete
  name: begin_delete
  summary: Deletes the specified HDInsight cluster.
  signature: 'begin_delete(resource_group_name: str, cluster_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_execute_script_actions
  name: begin_execute_script_actions
  summary: Executes script actions on the specified HDInsight cluster.
  signature: 'begin_execute_script_actions(resource_group_name: str, cluster_name:
    str, parameters: ''_models.ExecuteScriptActionParameters'', **kwargs: Any) ->
    LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The parameters for executing script actions.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.ExecuteScriptActionParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_resize
  name: begin_resize
  summary: Resizes the specified HDInsight cluster to the specified size.
  signature: 'begin_resize(resource_group_name: str, cluster_name: str, role_name:
    str | ''_models.RoleName'', parameters: ''_models.ClusterResizeParameters'', **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: role_name
    description: The constant value for the roleName.
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.hdinsight.models.RoleName>
  - name: parameters
    description: The parameters for the resize operation.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.ClusterResizeParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_rotate_disk_encryption_key
  name: begin_rotate_disk_encryption_key
  summary: Rotate disk encryption key of the specified HDInsight cluster.
  signature: 'begin_rotate_disk_encryption_key(resource_group_name: str, cluster_name:
    str, parameters: ''_models.ClusterDiskEncryptionParameters'', **kwargs: Any) ->
    LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The parameters for the disk encryption operation.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.ClusterDiskEncryptionParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_update_auto_scale_configuration
  name: begin_update_auto_scale_configuration
  summary: Updates the Autoscale Configuration for HDInsight cluster.
  signature: 'begin_update_auto_scale_configuration(resource_group_name: str, cluster_name:
    str, role_name: str | ''_models.RoleName'', parameters: ''_models.AutoscaleConfigurationUpdateParameter'',
    **kwargs: Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: role_name
    description: The constant value for the roleName.
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.hdinsight.models.RoleName>
  - name: parameters
    description: The parameters for the update autoscale configuration operation.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.AutoscaleConfigurationUpdateParameter>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_update_gateway_settings
  name: begin_update_gateway_settings
  summary: Configures the gateway settings on the specified cluster.
  signature: 'begin_update_gateway_settings(resource_group_name: str, cluster_name:
    str, parameters: ''_models.UpdateGatewaySettingsParameters'', **kwargs: Any) ->
    LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The cluster configurations.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.UpdateGatewaySettingsParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.begin_update_identity_certificate
  name: begin_update_identity_certificate
  summary: Updates the cluster identity certificate.
  signature: 'begin_update_identity_certificate(resource_group_name: str, cluster_name:
    str, parameters: ''_models.UpdateClusterIdentityCertificateParameters'', **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The cluster configurations.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.UpdateClusterIdentityCertificateParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: 'By default, your polling method will be ARMPolling.

      Pass in False for this operation to not poll, or pass in your own initialized
      polling object for a personal polling strategy.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.PollingMethod>
  - name: polling_interval
    description: Default waiting time between two polls for LRO operations if no Retry-After
      header is present.
    types:
    - <xref:int>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.get
  name: get
  summary: Gets the specified cluster.
  signature: 'get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> _models.Cluster'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Cluster, or the result of cls(response)
    types:
    - <xref:azure.mgmt.hdinsight.models.Cluster>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.get_azure_async_operation_status
  name: get_azure_async_operation_status
  summary: The the async operation status.
  signature: 'get_azure_async_operation_status(resource_group_name: str, cluster_name:
    str, operation_id: str, **kwargs: Any) -> _models.AsyncOperationResult'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: operation_id
    description: The long running operation id.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: AsyncOperationResult, or the result of cls(response)
    types:
    - <xref:azure.mgmt.hdinsight.models.AsyncOperationResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.get_gateway_settings
  name: get_gateway_settings
  summary: Gets the gateway settings for the specified cluster.
  signature: 'get_gateway_settings(resource_group_name: str, cluster_name: str, **kwargs:
    Any) -> _models.GatewaySettings'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: GatewaySettings, or the result of cls(response)
    types:
    - <xref:azure.mgmt.hdinsight.models.GatewaySettings>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.list
  name: list
  summary: Lists all the HDInsight clusters under the subscription.
  signature: 'list(**kwargs: Any) -> Iterable[''_models.ClusterListResult'']'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ClusterListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.hdinsight.models.ClusterListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Lists the HDInsight clusters in a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[''_models.ClusterListResult'']'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ClusterListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.hdinsight.models.ClusterListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.update
  name: update
  summary: Patch HDInsight cluster with the specified parameters.
  signature: 'update(resource_group_name: str, cluster_name: str, parameters: ''_models.ClusterPatchParameters'',
    **kwargs: Any) -> _models.Cluster'
  parameters:
  - name: resource_group_name
    description: The name of the resource group.
    isRequired: true
    types:
    - <xref:str>
  - name: cluster_name
    description: The name of the cluster.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: The cluster patch request.
    isRequired: true
    types:
    - <xref:azure.mgmt.hdinsight.models.ClusterPatchParameters>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Cluster, or the result of cls(response)
    types:
    - <xref:azure.mgmt.hdinsight.models.Cluster>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.hdinsight.operations.ClustersOperations.models
  name: models
  signature: models = <module 'azure.mgmt.hdinsight.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>