azure-mgmt-hdinsight 9.1.0b2
Microsoft Azure Hdinsight Management Client Library for Python
Requires Python: >=3.9
Keywords: azure, azure sdk

# Microsoft Azure SDK for Python

This is the Microsoft Azure HDInsight Management Client Library.
This package has been tested with Python 3.9+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _Disclaimer_

_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_

## Getting started

### Prerequisites

- Python 3.9+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-hdinsight
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.

With above configuration, client can be authenticated by following code:

```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.hdinsight import HDInsightManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = HDInsightManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```

## Examples

Code samples for this package can be found at:
- [Search HDInsight Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 

# Release History

## 9.1.0b2 (2025-10-15)

### Features Added

  - Model `HDInsightManagementClient` added parameter `cloud_setting` in method `__init__`
  - Model `GatewaySettings` added property `rest_auth_entra_users`
  - Model `UpdateGatewaySettingsParameters` added property `rest_auth_entra_users`
  - Added model `EntraUserInfo`

## 9.1.0b1 (2024-09-10)

### Other Changes

  - Regular release

## 9.0.0b3 (2024-08-21)

### Features Added

  - The 'azure.mgmt.hdinsight.operations.ExtensionsOperations' method 'begin_disable_azure_monitor_agent' was added in the current version
  - The 'azure.mgmt.hdinsight.operations.ExtensionsOperations' method 'begin_enable_azure_monitor_agent' was added in the current version
  - The 'azure.mgmt.hdinsight.operations.ExtensionsOperations' method 'get_azure_monitor_agent_status' was added in the current version
  - The 'azure.mgmt.hdinsight.aio.operations.ExtensionsOperations' method 'begin_disable_azure_monitor_agent' was added in the current version
  - The 'azure.mgmt.hdinsight.aio.operations.ExtensionsOperations' method 'begin_enable_azure_monitor_agent' was added in the current version
  - The 'azure.mgmt.hdinsight.aio.operations.ExtensionsOperations' method 'get_azure_monitor_agent_status' was added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.ClusterPatchParameters' had property 'identity' added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.NetworkProperties' had property 'outbound_dependencies_managed_type' added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.NetworkProperties' had property 'public_ip_tag' added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.StorageAccount' had property 'enable_secure_channel' added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.IpTag' was added in the current version
  - The model or publicly exposed class 'azure.mgmt.hdinsight.models.OutboundDependenciesManagedType' was added in the current version

## 9.0.0b2 (2023-07-21)

### Features Added

  - Model StorageAccount has a new parameter enable_secure_channel
  - Added feature to support selecting use secure channel during creation. The paramter would force to true if the cluster created based on a stroage account that secure transfer enabled, no matter it use 'blob' or 'dfs' type.

## 9.0.0b1 (2022-11-18)

### Other Changes

  - Added generated samples in github repo
  - Drop support for python<3.7.0

## 9.0.0 (2021-10-08)

**Features**

  - Model Cluster has a new parameter zones
  - Model Cluster has a new parameter system_data
  - Model ClusterGetProperties has a new parameter private_link_configurations
  - Model ClusterGetProperties has a new parameter private_endpoint_connections
  - Model ClusterCreateParametersExtended has a new parameter zones
  - Model ApplicationProperties has a new parameter private_link_configurations
  - Model ClusterCreateProperties has a new parameter private_link_configurations
  - Model VmSizeCompatibilityFilterV2 has a new parameter esp_applied
  - Model VmSizeCompatibilityFilterV2 has a new parameter compute_isolation_supported
  - Model Application has a new parameter system_data
  - Model ClusterCreateRequestValidationParameters has a new parameter zones
  - Added operation group PrivateLinkResourcesOperations
  - Added operation group PrivateEndpointConnectionsOperations

**Breaking changes**

  - Parameter location of model Cluster is now required
  - Parameter location of model TrackedResource is now required
  - Model CapabilitiesResult no longer has parameter vmsize_filters
  - Model CapabilitiesResult no longer has parameter vmsizes

## 8.0.0 (2021-06-03)

**Features**

  - Model Role has a new parameter encrypt_data_disks
  - Model Role has a new parameter vm_group_name
  - Model VmSizeCompatibilityFilter has a new parameter esp_applied
  - Model VmSizeCompatibilityFilter has a new parameter os_type
  - Model VmSizeCompatibilityFilter has a new parameter vm_sizes
  - Model VmSizeCompatibilityFilter has a new parameter compute_isolation_supported
  - Model ClusterGetProperties has a new parameter cluster_hdp_version
  - Model ClusterGetProperties has a new parameter excluded_services_config
  - Model ClusterGetProperties has a new parameter storage_profile
  - Model Operation has a new parameter properties
  - Model StorageAccount has a new parameter saskey
  - Model StorageAccount has a new parameter fileshare
  - Model CapabilitiesResult has a new parameter vmsizes
  - Model CapabilitiesResult has a new parameter vmsize_filters
  - Model ConnectivityEndpoint has a new parameter private_ip_address
  - Model ApplicationGetEndpoint has a new parameter private_ip_address
  - Model BillingResponseListResult has a new parameter vm_sizes_with_encryption_at_host
  - Model BillingResponseListResult has a new parameter vm_size_properties
  - Model OperationDisplay has a new parameter description
  - Model ApplicationGetHttpsEndpoint has a new parameter private_ip_address
  - Model ComponentsC51Ht8SchemasClusteridentityPropertiesUserassignedidentitiesAdditionalproperties has a new parameter tenant_id
  - Model KafkaRestProperties has a new parameter configuration_override
  - Added operation VirtualMachinesOperations.get_async_operation_status
  - Added operation ApplicationsOperations.get_azure_async_operation_status
  - Added operation LocationsOperations.get_azure_async_operation_status
  - Added operation LocationsOperations.check_name_availability
  - Added operation LocationsOperations.validate_cluster_create_request
  - Added operation ExtensionsOperations.get_azure_async_operation_status
  - Added operation ExtensionsOperations.get_azure_monitor_status
  - Added operation ExtensionsOperations.begin_disable_azure_monitor
  - Added operation ExtensionsOperations.begin_enable_azure_monitor
  - Added operation ClustersOperations.get_azure_async_operation_status
  - Added operation ClustersOperations.begin_update_identity_certificate
  - Added operation ScriptActionsOperations.get_execution_async_operation_status

**Breaking changes**

  - Model VmSizeCompatibilityFilter no longer has parameter vmsizes
  - Model CapabilitiesResult no longer has parameter vm_size_filters
  - Model CapabilitiesResult no longer has parameter vm_sizes

## 7.0.0 (2020-12-18)

**Features**

  - Model HostInfo has a new parameter effective_disk_encryption_key_url
  - Model HostInfo has a new parameter fqdn
  - Model ClusterGetProperties has a new parameter compute_isolation_properties
  - Model ClusterCreateProperties has a new parameter compute_isolation_properties

**Breaking changes**

  - Operation ExtensionsOperations.begin_create has a new signature
  - Operation ClustersOperations.begin_update_auto_scale_configuration has a new signature
  - Operation ClustersOperations.begin_resize has a new signature
  - Operation ClustersOperations.update has a new signature
  - Operation ExtensionsOperations.begin_create has a new signature
  - Operation ExtensionsOperations.begin_enable_monitoring has a new signature
  - Operation ClustersOperations.begin_execute_script_actions has a new signature

## 7.0.0b1 (2020-10-31)

This is beta preview version.
For detailed changelog please refer to equivalent stable version 2.0.0(https://pypi.org/project/azure-mgmt-hdinsight/2.0.0/)

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.


## 2.0.0 (2020-10-20)

**Features**

  - Model ClusterGetProperties has a new parameter network_properties
  - Model ClusterGetProperties has a new parameter cluster_id
  - Model ClusterCreateProperties has a new parameter network_properties

**Breaking changes**

  - Model ClusterGetProperties no longer has parameter network_settings
  - Model ClusterCreateProperties no longer has parameter network_settings

## 1.7.0 (2020-08-13)

**Features**

  - Model DiskEncryptionProperties has a new parameter encryption_at_host

## 1.6.0 (2020-07-17)

**Features**

  - Added operation group VirtualMachinesOperations

## 1.5.1 (2020-06-11)

**Bugfixes**

  - Fix the List Response

## 1.5.0 (2020-05-29)

**Features**

  - Added operation group VirtualMachinesOperations

## 1.4.0 (2020-01-16)

**Features**

  - Model ClusterCreateProperties has a new parameter
    min_supported_tls_version
  - Model ClusterGetProperties has a new parameter
    min_supported_tls_version

## 1.3.0 (2019-12-07)

**Features**

  - Model ClusterGetProperties has a new parameter
    kafka_rest_properties
  - Model ClusterCreateProperties has a new parameter
    kafka_rest_properties

## 1.2.0 (2019-08-06)

**Features**

  - Model Role has a new parameter autoscale_configuration
  - Added operation LocationsOperations.list_billing_specs
  - Added operation LocationsOperations.get_capabilities

## 1.1.0 (2019-06-17)

**Features**

  - Model ApplicationGetHttpsEndpoint has a new parameter
    disable_gateway_auth
  - Model ApplicationGetHttpsEndpoint has a new parameter
    sub_domain_suffix

## 1.0.0 (2019-04-08)

Stable versionning of the 0.3.0 (no changes)

## 0.3.0 (2019-04-08)

**Features**

  - Added operation ConfigurationsOperations.list
  - Added operation ClustersOperations.get_gateway_settings
  - Added operation ClustersOperations.update_gateway_settings

## 0.2.1 (2019-01-28)

**Features**

  - Add MSI support

## 0.2.0 (2018-12-11)

**Features**

  - Model SecurityProfile has a new parameter msi_resource_id
  - Model SecurityProfile has a new parameter aadds_resource_id
  - Model ClusterCreateProperties has a new parameter
    disk_encryption_properties
  - Model ClusterGetProperties has a new parameter
    disk_encryption_properties
  - Model Cluster has a new parameter identity
  - Model ClusterCreateParametersExtended has a new parameter identity
  - Added operation ClustersOperations.rotate_disk_encryption_key
  - Added operation ScriptActionsOperations.list_by_cluster
  - Added operation ScriptExecutionHistoryOperations.list_by_cluster
  - Added operation ConfigurationsOperations.update
  - Added operation ApplicationsOperations.list_by_cluster
  - Added operation group ExtensionsOperations

**Breaking changes**

  - Model ApplicationProperties no longer has parameter
    additional_properties
  - Model ApplicationGetHttpsEndpoint no longer has parameter
    additional_properties
  - Removed operation ScriptActionsOperations.list_persisted_scripts
  - Removed operation ScriptExecutionHistoryOperations.list
  - Removed operation ConfigurationsOperations.update_http_settings
  - Removed operation ApplicationsOperations.list
  - Removed operation LocationsOperations.get_capabilities
  - Removed operation group ExtensionOperations

## 0.1.0 (2018-08-08)

  - Initial Release