azure.mgmt.hdinsightcontainers.models module

class azure.mgmt.hdinsightcontainers.models.Action(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.

CANCEL = 'CANCEL'
DELETE = 'DELETE'
LAST_STATE_UPDATE = 'LAST_STATE_UPDATE'
LIST_SAVEPOINT = 'LIST_SAVEPOINT'
NEW = 'NEW'
RE_LAUNCH = 'RE_LAUNCH'
SAVEPOINT = 'SAVEPOINT'
START = 'START'
STATELESS_UPDATE = 'STATELESS_UPDATE'
STOP = 'STOP'
UPDATE = 'UPDATE'
class azure.mgmt.hdinsightcontainers.models.ActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'
class azure.mgmt.hdinsightcontainers.models.AksClusterProfile(*, aks_cluster_resource_id: str | None = None, aks_cluster_agent_pool_identity_profile: _models.AksClusterProfileAksClusterAgentPoolIdentityProfile | None = None, **kwargs: Any)[source]

Bases: Model

Properties of the cluster pool underlying AKS cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • aks_cluster_resource_id (str) – ARM Resource ID of the AKS cluster.

  • aks_cluster_agent_pool_identity_profile (AksClusterProfileAksClusterAgentPoolIdentityProfile) – Identity properties of the AKS cluster agentpool MSI.

  • aks_version (str) – AKS control plane and default node pool version of this ClusterPool.

Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.AksClusterProfileAksClusterAgentPoolIdentityProfile(*, msi_resource_id: str, msi_client_id: str, msi_object_id: str, **kwargs: Any)[source]

Bases: IdentityProfile

Identity properties of the AKS cluster agentpool MSI.

All required parameters must be populated in order to send to server.

Variables:

  • msi_resource_id (str) – ResourceId of the MSI. Required.

  • msi_client_id (str) – ClientId of the MSI. Required.

  • msi_object_id (str) – ObjectId of the MSI. Required.

Keyword Arguments:

  • msi_resource_id (str) – ResourceId of the MSI. Required.

  • msi_client_id (str) – ClientId of the MSI. Required.

  • msi_object_id (str) – ObjectId of the MSI. Required.

class azure.mgmt.hdinsightcontainers.models.AuthorizationProfile(*, user_ids: List[str] | None = None, group_ids: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.

Variables:

  • user_ids (list[str]) – AAD user Ids authorized for data plane access.

  • group_ids (list[str]) – AAD group Ids authorized for data plane access.

Keyword Arguments:

  • user_ids (list[str]) – AAD user Ids authorized for data plane access.

  • group_ids (list[str]) – AAD group Ids authorized for data plane access.

class azure.mgmt.hdinsightcontainers.models.AutoscaleProfile(*, enabled: bool, graceful_decommission_timeout: int | None = None, autoscale_type: str | _models.AutoscaleType | None = None, schedule_based_config: _models.ScheduleBasedConfig | None = None, load_based_config: _models.LoadBasedConfig | None = None, **kwargs: Any)[source]

Bases: Model

This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.

All required parameters must be populated in order to send to server.

Variables:

  • enabled (bool) – This indicates whether auto scale is enabled on HDInsight on AKS cluster. Required.

  • graceful_decommission_timeout (int) – This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout.

  • autoscale_type (str or AutoscaleType) – User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. Known values are: “ScheduleBased” and “LoadBased”.

  • schedule_based_config (ScheduleBasedConfig) – Profiles of schedule based Autoscale.

  • load_based_config (LoadBasedConfig) – Profiles of load based Autoscale.

Keyword Arguments:

  • enabled (bool) – This indicates whether auto scale is enabled on HDInsight on AKS cluster. Required.

  • graceful_decommission_timeout (int) – This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout.

  • autoscale_type (str or AutoscaleType) – User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based. Known values are: “ScheduleBased” and “LoadBased”.

  • schedule_based_config (ScheduleBasedConfig) – Profiles of schedule based Autoscale.

  • load_based_config (LoadBasedConfig) – Profiles of load based Autoscale.

class azure.mgmt.hdinsightcontainers.models.AutoscaleType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based.

LOAD_BASED = 'LoadBased'
SCHEDULE_BASED = 'ScheduleBased'
class azure.mgmt.hdinsightcontainers.models.CatalogOptions(*, hive: List[_models.HiveCatalogOption] | None = None, **kwargs: Any)[source]

Bases: Model

Trino cluster catalog options.

Variables:

hive (list[HiveCatalogOption]) – hive catalog options.

Keyword Arguments:

hive (list[HiveCatalogOption]) – hive catalog options.

class azure.mgmt.hdinsightcontainers.models.Category(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Category.

CUSTOM = 'custom'
PREDEFINED = 'predefined'
class azure.mgmt.hdinsightcontainers.models.Cluster(*, location: str, tags: Dict[str, str] | None = None, properties: _models.ClusterResourceProperties | None = None, **kwargs: Any)[source]

Bases: TrackedResource

The cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterResourceProperties) – Gets or sets the properties. Define cluster specific properties.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterResourceProperties) – Gets or sets the properties. Define cluster specific properties.

class azure.mgmt.hdinsightcontainers.models.ClusterAKSPatchVersionUpgradeProperties(**kwargs: Any)[source]

Bases: ClusterUpgradeProperties

Properties of upgrading cluster’s AKS patch version.

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterAccessProfile(*, enable_internal_ingress: bool, **kwargs: Any)[source]

Bases: Model

Cluster access profile.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • enable_internal_ingress (bool) – Whether to create cluster using private IP instead of public IP. This property must be set at create time. Required.

  • private_link_service_id (str) – Private link service resource ID. Only when enableInternalIngress is true, this property will be returned.

Keyword Arguments:

enable_internal_ingress (bool) – Whether to create cluster using private IP instead of public IP. This property must be set at create time. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterAksPatchUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, original_version: str | None = None, new_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterUpgradeHistoryProperties

Cluster aks patch upgrade history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • original_version (str) – Version before update.

  • new_version (str) – Version going to update.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • original_version (str) – Version before update.

  • new_version (str) – Version going to update.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableInPlaceUpgradeProperties(*, description: str | None = None, source_oss_version: str | None = None, source_cluster_version: str | None = None, source_build_number: str | None = None, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.Severity | None = None, extended_properties: str | None = None, created_time: datetime | None = None, **kwargs: Any)[source]

Bases: ClusterAvailableUpgradeProperties

Cluster available in-place upgrade.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterAvailableUpgradeHotfixUpgradeProperties, ClusterAvailableUpgradePatchVersionUpgradeProperties

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

Keyword Arguments:

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgrade(*, properties: _models.ClusterAvailableUpgradeProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Cluster available upgrade.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterAvailableUpgradeProperties) – Gets or sets the properties. Define cluster upgrade specific properties.

Keyword Arguments:

properties (ClusterAvailableUpgradeProperties) – Gets or sets the properties. Define cluster upgrade specific properties.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradeAksPatchUpgradeProperties(*, current_version: str | None = None, current_version_status: str | _models.CurrentClusterAksVersionStatus | None = None, latest_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterAvailableUpgradeProperties

Cluster available AKS patch version upgrade.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • current_version (str) – Current node pool version.

  • current_version_status (str or CurrentClusterAksVersionStatus) – Current AKS version’s status: whether it is deprecated or supported. Known values are: “Deprecated” and “Supported”.

  • latest_version (str) – Latest available version, which should be equal to AKS control plane version if it’s not deprecated.

Keyword Arguments:

  • current_version (str) – Current node pool version.

  • current_version_status (str or CurrentClusterAksVersionStatus) – Current AKS version’s status: whether it is deprecated or supported. Known values are: “Deprecated” and “Supported”.

  • latest_version (str) – Latest available version, which should be equal to AKS control plane version if it’s not deprecated.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradeHotfixUpgradeProperties(*, description: str | None = None, source_oss_version: str | None = None, source_cluster_version: str | None = None, source_build_number: str | None = None, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.Severity | None = None, extended_properties: str | None = None, created_time: datetime | None = None, **kwargs: Any)[source]

Bases: ClusterAvailableInPlaceUpgradeProperties

Cluster available hotfix version upgrade.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

Keyword Arguments:

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradeList(*, value: List[_models.ClusterAvailableUpgrade], next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Collection of cluster available upgrade.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradePatchVersionUpgradeProperties(*, description: str | None = None, source_oss_version: str | None = None, source_cluster_version: str | None = None, source_build_number: str | None = None, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.Severity | None = None, extended_properties: str | None = None, created_time: datetime | None = None, **kwargs: Any)[source]

Bases: ClusterAvailableInPlaceUpgradeProperties

Cluster available patch version upgrade.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

Keyword Arguments:

  • description (str) – Hotfix version upgrade description.

  • source_oss_version (str) – Source OSS version of current cluster component.

  • source_cluster_version (str) – Source cluster version of current cluster component.

  • source_build_number (str) – Source build number of current cluster component.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

  • severity (str or Severity) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

  • extended_properties (str) – Extended properties of current available upgrade version.

  • created_time (datetime) – Created time of current available upgrade version.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradeProperties(**kwargs: Any)[source]

Bases: Model

Cluster available upgrade properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterAvailableUpgradeAksPatchUpgradeProperties, ClusterAvailableInPlaceUpgradeProperties

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterAvailableUpgradeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
HOTFIX_UPGRADE = 'HotfixUpgrade'
PATCH_VERSION_UPGRADE = 'PatchVersionUpgrade'
class azure.mgmt.hdinsightcontainers.models.ClusterComponentsItem(*, name: str | None = None, version: str | None = None, **kwargs: Any)[source]

Bases: Model

ClusterComponentsItem.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterConfigFile(*, file_name: str, content: str | None = None, encoding: str | _models.ContentEncoding | None = None, path: str | None = None, values: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster configuration files.

All required parameters must be populated in order to send to server.

Variables:

  • file_name (str) – Configuration file name. Required.

  • content (str) – Free form content of the entire configuration file.

  • encoding (str or ContentEncoding) – This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. Known values are: “Base64” and “None”.

  • path (str) – Path of the config file if content is specified.

  • values (dict[str, str]) – List of key value pairs where key represents a valid service configuration name and value represents the value of the config.

Keyword Arguments:

  • file_name (str) – Configuration file name. Required.

  • content (str) – Free form content of the entire configuration file.

  • encoding (str or ContentEncoding) – This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text. Known values are: “Base64” and “None”.

  • path (str) – Path of the config file if content is specified.

  • values (dict[str, str]) – List of key value pairs where key represents a valid service configuration name and value represents the value of the config.

class azure.mgmt.hdinsightcontainers.models.ClusterHotfixUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, source_cluster_version: str | None = None, source_oss_version: str | None = None, source_build_number: str | None = None, target_cluster_version: str | None = None, target_oss_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.ClusterUpgradeHistorySeverityType | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeHistoryProperties

Cluster hotfix upgrade history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

class azure.mgmt.hdinsightcontainers.models.ClusterHotfixUpgradeProperties(*, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeProperties

Properties of upgrading cluster’s hotfix.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

Keyword Arguments:

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

class azure.mgmt.hdinsightcontainers.models.ClusterHotfixUpgradeRollbackHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, source_cluster_version: str | None = None, source_oss_version: str | None = None, source_build_number: str | None = None, target_cluster_version: str | None = None, target_oss_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.ClusterUpgradeHistorySeverityType | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeHistoryProperties

Cluster hotfix upgrade rollback history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

class azure.mgmt.hdinsightcontainers.models.ClusterInPlaceUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, source_cluster_version: str | None = None, source_oss_version: str | None = None, source_build_number: str | None = None, target_cluster_version: str | None = None, target_oss_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.ClusterUpgradeHistorySeverityType | None = None, **kwargs: Any)[source]

Bases: ClusterUpgradeHistoryProperties

Cluster in-place upgrade history properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterHotfixUpgradeHistoryProperties, ClusterHotfixUpgradeRollbackHistoryProperties, ClusterPatchVersionUpgradeHistoryProperties, ClusterPatchVersionUpgradeRollbackHistoryProperties

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

class azure.mgmt.hdinsightcontainers.models.ClusterInPlaceUpgradeProperties(*, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, **kwargs: Any)[source]

Bases: ClusterUpgradeProperties

Properties of in-place upgrading cluster.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterHotfixUpgradeProperties, ClusterPatchVersionUpgradeProperties

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

Keyword Arguments:

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewProperties(*, status: _models.ClusterInstanceViewPropertiesStatus, service_statuses: List[_models.ServiceStatus], **kwargs: Any)[source]

Bases: Model

Cluster Instance View Properties.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewPropertiesStatus(*, ready: str, reason: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: ClusterInstanceViewStatus

Status of the instance view.

All required parameters must be populated in order to send to server.

Variables:

  • ready (str) – The cluster ready status. Required.

  • reason (str) – The status reason.

  • message (str) – The additional message.

Keyword Arguments:

  • ready (str) – The cluster ready status. Required.

  • reason (str) – The status reason.

  • message (str) – The additional message.

class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewResult(*, name: str, properties: _models.ClusterInstanceViewResultProperties, **kwargs: Any)[source]

Bases: Model

Cluster Instance View.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewResultProperties(*, status: _models.ClusterInstanceViewPropertiesStatus, service_statuses: List[_models.ServiceStatus], **kwargs: Any)[source]

Bases: ClusterInstanceViewProperties

Properties of the instance view.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewStatus(*, ready: str, reason: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

Status of the instance view.

All required parameters must be populated in order to send to server.

Variables:

  • ready (str) – The cluster ready status. Required.

  • reason (str) – The status reason.

  • message (str) – The additional message.

Keyword Arguments:

  • ready (str) – The cluster ready status. Required.

  • reason (str) – The status reason.

  • message (str) – The additional message.

class azure.mgmt.hdinsightcontainers.models.ClusterInstanceViewsResult(*, value: List[_models.ClusterInstanceViewResult] | None = None, **kwargs: Any)[source]

Bases: Model

The instance view of a HDInsight Cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
Keyword Arguments:

value (list[ClusterInstanceViewResult]) – Cluster instance view array.

class azure.mgmt.hdinsightcontainers.models.ClusterJob(*, properties: _models.ClusterJobProperties, **kwargs: Any)[source]

Bases: ProxyResource

Cluster job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterJobProperties) – Properties of cluster job. Required.

Keyword Arguments:

properties (ClusterJobProperties) – Properties of cluster job. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterJobList(*, value: List[_models.ClusterJob], next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Collection of cluster job.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ClusterJob]) – Collection of cluster job. Required.

  • next_link (str) – The Url of next result page.

Keyword Arguments:

  • value (list[ClusterJob]) – Collection of cluster job. Required.

  • next_link (str) – The Url of next result page.

class azure.mgmt.hdinsightcontainers.models.ClusterJobProperties(**kwargs: Any)[source]

Bases: Model

Properties of cluster job.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: FlinkJobProperties

All required parameters must be populated in order to send to server.

Variables:

job_type (str or JobType) – Type of cluster job. Required. “FlinkJob”

class azure.mgmt.hdinsightcontainers.models.ClusterLibrary(*, properties: _models.ClusterLibraryProperties, **kwargs: Any)[source]

Bases: ProxyResource

Libraries in the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterLibraryProperties) – Properties of a library in the cluster. Required.

Keyword Arguments:

properties (ClusterLibraryProperties) – Properties of a library in the cluster. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterLibraryList(*, value: List[_models.ClusterLibrary], **kwargs: Any)[source]

Bases: Model

Collection of libraries in the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ClusterLibrary]) – Collection of libraries in the cluster. Required.

  • next_link (str) – The url of next result page.

Keyword Arguments:

value (list[ClusterLibrary]) – Collection of libraries in the cluster. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterLibraryManagementOperation(*, properties: _models.ClusterLibraryManagementOperationProperties, **kwargs: Any)[source]

Bases: ProxyResource

Library management operation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterLibraryManagementOperationProperties) – Properties of a library management operation. Required.

Keyword Arguments:

properties (ClusterLibraryManagementOperationProperties) – Properties of a library management operation. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterLibraryManagementOperationProperties(*, action: str | _models.LibraryManagementAction, libraries: List[_models.ClusterLibrary], **kwargs: Any)[source]

Bases: Model

Properties of a library management operation.

All required parameters must be populated in order to send to server.

Variables:

  • action (str or LibraryManagementAction) – The library management action. Required. Known values are: “Install” and “Uninstall”.

  • libraries (list[ClusterLibrary]) – The libraries to be installed/updated/uninstalled. Required.

Keyword Arguments:

  • action (str or LibraryManagementAction) – The library management action. Required. Known values are: “Install” and “Uninstall”.

  • libraries (list[ClusterLibrary]) – The libraries to be installed/updated/uninstalled. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterLibraryProperties(*, remarks: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties of a library in the cluster.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MavenLibraryProperties, PyPiLibraryProperties

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • type (str or Type) – Type of the library. Required. Known values are: “pypi” and “maven”.

  • remarks (str) – Remark of the latest library management operation.

  • timestamp (datetime) – Timestamp of the latest library management operation.

  • status (str or Status) – Status of the library. Known values are: “INSTALLING”, “INSTALLED”, “INSTALL_FAILED”, “UNINSTALLING”, and “UNINSTALL_FAILED”.

  • message (str) – Error message of the library operation when a failure occurs.

Keyword Arguments:

remarks (str) – Remark of the latest library management operation.

class azure.mgmt.hdinsightcontainers.models.ClusterListResult(*, value: List[_models.Cluster] | None = None, **kwargs: Any)[source]

Bases: Model

The list cluster operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Cluster]) – The list of clusters.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[Cluster]) – The list of clusters.

class azure.mgmt.hdinsightcontainers.models.ClusterLogAnalyticsApplicationLogs(*, std_out_enabled: bool | None = None, std_error_enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Collection of logs to be enabled or disabled for log analytics.

Variables:

  • std_out_enabled (bool) – True if stdout is enabled, otherwise false.

  • std_error_enabled (bool) – True if stderror is enabled, otherwise false.

Keyword Arguments:

  • std_out_enabled (bool) – True if stdout is enabled, otherwise false.

  • std_error_enabled (bool) – True if stderror is enabled, otherwise false.

class azure.mgmt.hdinsightcontainers.models.ClusterLogAnalyticsProfile(*, enabled: bool, application_logs: _models.ClusterLogAnalyticsApplicationLogs | None = None, metrics_enabled: bool | None = None, **kwargs: Any)[source]

Bases: Model

Cluster log analytics profile to enable or disable OMS agent for cluster.

All required parameters must be populated in order to send to server.

Variables:

  • enabled (bool) – True if log analytics is enabled for the cluster, otherwise false. Required.

  • application_logs (ClusterLogAnalyticsApplicationLogs) – Collection of logs to be enabled or disabled for log analytics.

  • metrics_enabled (bool) – True if metrics are enabled, otherwise false.

Keyword Arguments:

  • enabled (bool) – True if log analytics is enabled for the cluster, otherwise false. Required.

  • application_logs (ClusterLogAnalyticsApplicationLogs) – Collection of logs to be enabled or disabled for log analytics.

  • metrics_enabled (bool) – True if metrics are enabled, otherwise false.

class azure.mgmt.hdinsightcontainers.models.ClusterPatch(*, properties: _models.ClusterPatchProperties | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

The patch for a cluster.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterPatchProperties(*, cluster_profile: _models.UpdatableClusterProfile | None = None, **kwargs: Any)[source]

Bases: Model

Cluster resource patch data.

Variables:

cluster_profile (UpdatableClusterProfile) – Cluster resource patch properties.

Keyword Arguments:

cluster_profile (UpdatableClusterProfile) – Cluster resource patch properties.

class azure.mgmt.hdinsightcontainers.models.ClusterPatchVersionUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, source_cluster_version: str | None = None, source_oss_version: str | None = None, source_build_number: str | None = None, target_cluster_version: str | None = None, target_oss_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.ClusterUpgradeHistorySeverityType | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeHistoryProperties

Cluster patch version upgrade history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

class azure.mgmt.hdinsightcontainers.models.ClusterPatchVersionUpgradeProperties(*, target_oss_version: str | None = None, target_cluster_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeProperties

Properties of upgrading cluster’s patch version.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

Keyword Arguments:

  • target_oss_version (str) – Target OSS version of component to be upgraded.

  • target_cluster_version (str) – Target cluster version of component to be upgraded.

  • target_build_number (str) – Target build number of component to be upgraded.

  • component_name (str) – Name of component to be upgraded.

class azure.mgmt.hdinsightcontainers.models.ClusterPatchVersionUpgradeRollbackHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, source_cluster_version: str | None = None, source_oss_version: str | None = None, source_build_number: str | None = None, target_cluster_version: str | None = None, target_oss_version: str | None = None, target_build_number: str | None = None, component_name: str | None = None, severity: str | _models.ClusterUpgradeHistorySeverityType | None = None, **kwargs: Any)[source]

Bases: ClusterInPlaceUpgradeHistoryProperties

Cluster patch version upgrade rollback history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • source_cluster_version (str) – Version with three part.

  • source_oss_version (str) – Version with three part.

  • source_build_number (str) – Source build number.

  • target_cluster_version (str) – Version with three part.

  • target_oss_version (str) – Version with three part.

  • target_build_number (str) – Target build number.

  • component_name (str) – Component name to upgrade.

  • severity (str or ClusterUpgradeHistorySeverityType) – Severity of this upgrade. Known values are: “low”, “medium”, “high”, and “critical”.

class azure.mgmt.hdinsightcontainers.models.ClusterPool(*, location: str, tags: Dict[str, str] | None = None, properties: _models.ClusterPoolResourceProperties | None = None, **kwargs: Any)[source]

Bases: TrackedResource

Cluster pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterPoolResourceProperties) – Gets or sets the properties. Define cluster pool specific properties.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterPoolResourceProperties) – Gets or sets the properties. Define cluster pool specific properties.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAKSPatchVersionUpgradeProperties(*, upgrade_cluster_pool: bool = False, upgrade_all_cluster_nodes: bool = False, target_aks_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolUpgradeProperties

Properties of upgrading cluster pool’s AKS patch version.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterPoolUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

  • upgrade_cluster_pool (bool) – whether upgrade cluster pool or not. If it’s true, upgradeAllClusterNodes should be false.

  • upgrade_all_cluster_nodes (bool) – whether upgrade all clusters’ nodes. If it’s true, upgradeClusterPool should be false.

  • target_aks_version (str) – Target AKS version. When it’s not set, latest version will be used. When upgradeClusterPool is true and upgradeAllClusterNodes is false, target version should be greater or equal to current version. When upgradeClusterPool is false and upgradeAllClusterNodes is true, target version should be equal to AKS version of cluster pool.

Keyword Arguments:

  • upgrade_cluster_pool (bool) – whether upgrade cluster pool or not. If it’s true, upgradeAllClusterNodes should be false.

  • upgrade_all_cluster_nodes (bool) – whether upgrade all clusters’ nodes. If it’s true, upgradeClusterPool should be false.

  • target_aks_version (str) – Target AKS version. When it’s not set, latest version will be used. When upgradeClusterPool is true and upgradeAllClusterNodes is false, target version should be greater or equal to current version. When upgradeClusterPool is false and upgradeAllClusterNodes is true, target version should be equal to AKS version of cluster pool.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAksPatchUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterPoolUpgradeHistoryUpgradeResultType, upgrade_cluster_pool: bool | None = None, upgrade_all_cluster_nodes: bool | None = None, original_version: str | None = None, new_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolUpgradeHistoryProperties

Cluster pool aks upgrade history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterPoolUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterPoolUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • upgrade_cluster_pool (bool) – Whether upgrade cluster pool.

  • upgrade_all_cluster_nodes (bool) – Whether upgrade all cluster nodes.

  • original_version (str) – Version before update.

  • new_version (str) – Version going to update.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterPoolUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • upgrade_cluster_pool (bool) – Whether upgrade cluster pool.

  • upgrade_all_cluster_nodes (bool) – Whether upgrade all cluster nodes.

  • original_version (str) – Version before update.

  • new_version (str) – Version going to update.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgrade(*, properties: _models.ClusterPoolAvailableUpgradeProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Cluster pool available upgrade.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterPoolAvailableUpgradeProperties) – Gets or sets the properties. Define cluster pool upgrade specific properties.

Keyword Arguments:

properties (ClusterPoolAvailableUpgradeProperties) – Gets or sets the properties. Define cluster pool upgrade specific properties.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgradeAksPatchUpgradeProperties(*, current_version: str | None = None, current_version_status: str | _models.CurrentClusterPoolAksVersionStatus | None = None, latest_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolAvailableUpgradeProperties

Cluster pool available AKS patch version upgrade.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterPoolAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

  • current_version (str) – Current AKS version.

  • current_version_status (str or CurrentClusterPoolAksVersionStatus) – Current AKS version’s status: whether it is deprecated or supported. Known values are: “Deprecated” and “Supported”.

  • latest_version (str) – Latest AKS patch version.

Keyword Arguments:

  • current_version (str) – Current AKS version.

  • current_version_status (str or CurrentClusterPoolAksVersionStatus) – Current AKS version’s status: whether it is deprecated or supported. Known values are: “Deprecated” and “Supported”.

  • latest_version (str) – Latest AKS patch version.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgradeList(*, value: List[_models.ClusterPoolAvailableUpgrade], next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

collection of cluster pool available upgrade.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgradeNodeOsUpgradeProperties(*, latest_version: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolAvailableUpgradeProperties

Cluster pool available node OS update.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterPoolAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

  • latest_version (str) – The latest node OS version.

Keyword Arguments:

latest_version (str) – The latest node OS version.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgradeProperties(**kwargs: Any)[source]

Bases: Model

Cluster pool available upgrade properties.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterPoolAvailableUpgradeAksPatchUpgradeProperties, ClusterPoolAvailableUpgradeNodeOsUpgradeProperties

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterPoolAvailableUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolAvailableUpgradeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
NODE_OS_UPGRADE = 'NodeOsUpgrade'
class azure.mgmt.hdinsightcontainers.models.ClusterPoolComputeProfile(*, vm_size: str, availability_zones: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster pool compute profile.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • vm_size (str) – The virtual machine SKU. Required.

  • count (int) – The number of virtual machines.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

Keyword Arguments:

  • vm_size (str) – The virtual machine SKU. Required.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolListResult(*, value: List[_models.ClusterPool] | None = None, **kwargs: Any)[source]

Bases: Model

The list cluster pools operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ClusterPool]) – The list of cluster pools.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ClusterPool]) – The list of cluster pools.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolLogAnalyticsProfile(*, enabled: bool, workspace_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.

All required parameters must be populated in order to send to server.

Variables:

  • enabled (bool) – True if log analytics is enabled for cluster pool, otherwise false. Required.

  • workspace_id (str) – Log analytics workspace to associate with the OMS agent.

Keyword Arguments:

  • enabled (bool) – True if log analytics is enabled for cluster pool, otherwise false. Required.

  • workspace_id (str) – Log analytics workspace to associate with the OMS agent.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolNetworkProfile(*, subnet_id: str, outbound_type: str | _models.OutboundType = 'loadBalancer', enable_private_api_server: bool | None = None, api_server_authorized_ip_ranges: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster pool networking configuration.

All required parameters must be populated in order to send to server.

Variables:

  • subnet_id (str) – Cluster pool subnet resource id. Required.

  • outbound_type (str or OutboundType) – This can only be set at cluster pool creation time and cannot be changed later. Known values are: “loadBalancer” and “userDefinedRouting”.

  • enable_private_api_server (bool) – ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

  • api_server_authorized_ip_ranges (list[str]) – IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don’t use it.

Keyword Arguments:

  • subnet_id (str) – Cluster pool subnet resource id. Required.

  • outbound_type (str or OutboundType) – This can only be set at cluster pool creation time and cannot be changed later. Known values are: “loadBalancer” and “userDefinedRouting”.

  • enable_private_api_server (bool) – ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

  • api_server_authorized_ip_ranges (list[str]) – IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don’t use it.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolNodeOsImageUpdateProperties(**kwargs: Any)[source]

Bases: ClusterPoolUpgradeProperties

Properties of upgrading cluster pool’s AKS patch version.

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterPoolUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolNodeOsUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterPoolUpgradeHistoryUpgradeResultType, new_node_os: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolUpgradeHistoryProperties

Cluster pool node os upgrade history properties.

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterPoolUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterPoolUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • new_node_os (str) – New Node Os version.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterPoolUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

  • new_node_os (str) – New Node Os version.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolProfile(*, cluster_pool_version: str, public_ip_tag: _models.IpTag | None = None, **kwargs: Any)[source]

Bases: Model

Cluster pool profile.

All required parameters must be populated in order to send to server.

Variables:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version. Required.

  • public_ip_tag (IpTag) – Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters.

Keyword Arguments:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version. Required.

  • public_ip_tag (IpTag) – Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourceProperties(*, compute_profile: _models.ClusterPoolResourcePropertiesComputeProfile, managed_resource_group_name: str | None = None, cluster_pool_profile: _models.ClusterPoolResourcePropertiesClusterPoolProfile | None = None, network_profile: _models.ClusterPoolResourcePropertiesNetworkProfile | None = None, log_analytics_profile: _models.ClusterPoolResourcePropertiesLogAnalyticsProfile | None = None, **kwargs: Any)[source]

Bases: Model

Cluster pool resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • provisioning_state (str or ProvisioningStatus) – Provisioning state of the resource. Known values are: “Accepted”, “Succeeded”, “Canceled”, and “Failed”.

  • deployment_id (str) – A unique id generated by the RP to identify the resource.

  • managed_resource_group_name (str) – A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC{managedResourceGroupName}{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.

  • aks_managed_resource_group_name (str) – A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC{managedResourceGroupName}{clusterPoolName}_{region}.

  • cluster_pool_profile (ClusterPoolResourcePropertiesClusterPoolProfile) – CLuster pool profile.

  • compute_profile (ClusterPoolResourcePropertiesComputeProfile) – CLuster pool compute profile. Required.

  • aks_cluster_profile (ClusterPoolResourcePropertiesAksClusterProfile) – Properties of underlying AKS cluster.

  • network_profile (ClusterPoolResourcePropertiesNetworkProfile) – Cluster pool network profile.

  • log_analytics_profile (ClusterPoolResourcePropertiesLogAnalyticsProfile) – Cluster pool log analytics profile to enable OMS agent for AKS cluster.

  • status (str) – Business status of the resource.

Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourcePropertiesAksClusterProfile(*, aks_cluster_resource_id: str | None = None, aks_cluster_agent_pool_identity_profile: _models.AksClusterProfileAksClusterAgentPoolIdentityProfile | None = None, **kwargs: Any)[source]

Bases: AksClusterProfile

Properties of underlying AKS cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • aks_cluster_resource_id (str) – ARM Resource ID of the AKS cluster.

  • aks_cluster_agent_pool_identity_profile (AksClusterProfileAksClusterAgentPoolIdentityProfile) – Identity properties of the AKS cluster agentpool MSI.

  • aks_version (str) – AKS control plane and default node pool version of this ClusterPool.

Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourcePropertiesClusterPoolProfile(*, cluster_pool_version: str, public_ip_tag: _models.IpTag | None = None, **kwargs: Any)[source]

Bases: ClusterPoolProfile

CLuster pool profile.

All required parameters must be populated in order to send to server.

Variables:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version. Required.

  • public_ip_tag (IpTag) – Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters.

Keyword Arguments:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version. Required.

  • public_ip_tag (IpTag) – Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourcePropertiesComputeProfile(*, vm_size: str, availability_zones: List[str] | None = None, **kwargs: Any)[source]

Bases: ClusterPoolComputeProfile

CLuster pool compute profile.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • vm_size (str) – The virtual machine SKU. Required.

  • count (int) – The number of virtual machines.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

Keyword Arguments:

  • vm_size (str) – The virtual machine SKU. Required.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourcePropertiesLogAnalyticsProfile(*, enabled: bool, workspace_id: str | None = None, **kwargs: Any)[source]

Bases: ClusterPoolLogAnalyticsProfile

Cluster pool log analytics profile to enable OMS agent for AKS cluster.

All required parameters must be populated in order to send to server.

Variables:

  • enabled (bool) – True if log analytics is enabled for cluster pool, otherwise false. Required.

  • workspace_id (str) – Log analytics workspace to associate with the OMS agent.

Keyword Arguments:

  • enabled (bool) – True if log analytics is enabled for cluster pool, otherwise false. Required.

  • workspace_id (str) – Log analytics workspace to associate with the OMS agent.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolResourcePropertiesNetworkProfile(*, subnet_id: str, outbound_type: str | _models.OutboundType = 'loadBalancer', enable_private_api_server: bool | None = None, api_server_authorized_ip_ranges: List[str] | None = None, **kwargs: Any)[source]

Bases: ClusterPoolNetworkProfile

Cluster pool network profile.

All required parameters must be populated in order to send to server.

Variables:

  • subnet_id (str) – Cluster pool subnet resource id. Required.

  • outbound_type (str or OutboundType) – This can only be set at cluster pool creation time and cannot be changed later. Known values are: “loadBalancer” and “userDefinedRouting”.

  • enable_private_api_server (bool) – ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

  • api_server_authorized_ip_ranges (list[str]) – IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don’t use it.

Keyword Arguments:

  • subnet_id (str) – Cluster pool subnet resource id. Required.

  • outbound_type (str or OutboundType) – This can only be set at cluster pool creation time and cannot be changed later. Known values are: “loadBalancer” and “userDefinedRouting”.

  • enable_private_api_server (bool) – ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.

  • api_server_authorized_ip_ranges (list[str]) – IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don’t use it.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgrade(*, properties: _models.ClusterPoolUpgradeProperties, **kwargs: Any)[source]

Bases: Model

Cluster Pool Upgrade.

All required parameters must be populated in order to send to server.

Variables:

properties (ClusterPoolUpgradeProperties) – Properties of upgrading cluster pool. Required.

Keyword Arguments:

properties (ClusterPoolUpgradeProperties) – Properties of upgrading cluster pool. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeHistory(*, properties: _models.ClusterPoolUpgradeHistoryProperties, **kwargs: Any)[source]

Bases: ProxyResource

Cluster pool upgrade history.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterPoolUpgradeHistoryProperties) – Properties of cluster pool upgrade history. Required.

Keyword Arguments:

properties (ClusterPoolUpgradeHistoryProperties) – Properties of cluster pool upgrade history. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeHistoryListResult(*, value: List[_models.ClusterPoolUpgradeHistory], **kwargs: Any)[source]

Bases: Model

Represents a list of cluster pool upgrade history.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ClusterPoolUpgradeHistory]) – The list of cluster pool upgrade history. Required.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ClusterPoolUpgradeHistory]) – The list of cluster pool upgrade history. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterPoolUpgradeHistoryUpgradeResultType, **kwargs: Any)[source]

Bases: Model

Properties of cluster pool upgrade history.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterPoolAksPatchUpgradeHistoryProperties, ClusterPoolNodeOsUpgradeHistoryProperties

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeHistoryType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
NODE_OS_UPGRADE = 'NodeOsUpgrade'
class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeHistoryUpgradeResultType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Result of this upgrade.

FAILED = 'Failed'
SUCCEED = 'Succeed'
class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeProperties(**kwargs: Any)[source]

Bases: Model

Properties of upgrading cluster pool.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterPoolAKSPatchVersionUpgradeProperties, ClusterPoolNodeOsImageUpdateProperties

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterPoolUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade” and “NodeOsUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolUpgradeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
NODE_OS_UPGRADE = 'NodeOsUpgrade'
class azure.mgmt.hdinsightcontainers.models.ClusterPoolVersion(*, properties: _models.ClusterPoolVersionProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Available cluster pool version.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterPoolVersionProperties) – Cluster pool version properties.

Keyword Arguments:

properties (ClusterPoolVersionProperties) – Cluster pool version properties.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolVersionProperties(*, cluster_pool_version: str | None = None, aks_version: str | None = None, is_preview: bool = False, **kwargs: Any)[source]

Bases: Model

Cluster pool version properties.

Variables:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version.

  • aks_version (str) – AKS version.

  • is_preview (bool) – Indicate if this version is in preview or not.

Keyword Arguments:

  • cluster_pool_version (str) – Cluster pool version is a 2-part version.

  • aks_version (str) – AKS version.

  • is_preview (bool) – Indicate if this version is in preview or not.

class azure.mgmt.hdinsightcontainers.models.ClusterPoolVersionsListResult(*, value: List[_models.ClusterPoolVersion] | None = None, **kwargs: Any)[source]

Bases: Model

Represents a list of cluster pool versions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ClusterPoolVersion]) – The list of cluster pool versions.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ClusterPoolVersion]) – The list of cluster pool versions.

class azure.mgmt.hdinsightcontainers.models.ClusterProfile(*, cluster_version: str, oss_version: str, authorization_profile: _models.AuthorizationProfile, identity_profile: _models.IdentityProfile | None = None, managed_identity_profile: _models.ManagedIdentityProfile | None = None, secrets_profile: _models.SecretsProfile | None = None, service_configs_profiles: List[_models.ClusterServiceConfigsProfile] | None = None, cluster_access_profile: _models.ClusterAccessProfile | None = None, log_analytics_profile: _models.ClusterLogAnalyticsProfile | None = None, prometheus_profile: _models.ClusterPrometheusProfile | None = None, ssh_profile: _models.SshProfile | None = None, autoscale_profile: _models.AutoscaleProfile | None = None, ranger_plugin_profile: _models.ClusterRangerPluginProfile | None = None, kafka_profile: _models.KafkaProfile | None = None, trino_profile: _models.TrinoProfile | None = None, llap_profile: Dict[str, Any] | None = None, flink_profile: _models.FlinkProfile | None = None, spark_profile: _models.SparkProfile | None = None, ranger_profile: _models.RangerProfile | None = None, stub_profile: Dict[str, Any] | None = None, script_action_profiles: List[_models.ScriptActionProfile] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster profile.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • cluster_version (str) – Version with 3/4 part. Required.

  • oss_version (str) – Version with three part. Required.

  • components (list[ClusterComponentsItem]) – Component list of this cluster type and version.

  • identity_profile (IdentityProfile) – This is deprecated. Please use managed identity profile instead.

  • managed_identity_profile (ManagedIdentityProfile) – This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster.

  • authorization_profile (AuthorizationProfile) – Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. Required.

  • secrets_profile (SecretsProfile) – The cluster secret profile.

  • service_configs_profiles (list[ClusterServiceConfigsProfile]) – The service configs profiles.

  • connectivity_profile (ConnectivityProfile) – Cluster connectivity profile.

  • cluster_access_profile (ClusterAccessProfile) – Cluster access profile.

  • log_analytics_profile (ClusterLogAnalyticsProfile) – Cluster log analytics profile to enable or disable OMS agent for cluster.

  • prometheus_profile (ClusterPrometheusProfile) – Cluster Prometheus profile.

  • ssh_profile (SshProfile) – Ssh profile for the cluster.

  • autoscale_profile (AutoscaleProfile) – This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.

  • ranger_plugin_profile (ClusterRangerPluginProfile) – Cluster Ranger plugin profile.

  • kafka_profile (KafkaProfile) – The Kafka cluster profile.

  • trino_profile (TrinoProfile) – Trino Cluster profile.

  • llap_profile (dict[str, any]) – LLAP cluster profile.

  • flink_profile (FlinkProfile) – The Flink cluster profile.

  • spark_profile (SparkProfile) – The spark cluster profile.

  • ranger_profile (RangerProfile) – The ranger cluster profile.

  • stub_profile (dict[str, any]) – Stub cluster profile.

  • script_action_profiles (list[ScriptActionProfile]) – The script action profile list.

Keyword Arguments:

  • cluster_version (str) – Version with 3/4 part. Required.

  • oss_version (str) – Version with three part. Required.

  • identity_profile (IdentityProfile) – This is deprecated. Please use managed identity profile instead.

  • managed_identity_profile (ManagedIdentityProfile) – This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster.

  • authorization_profile (AuthorizationProfile) – Authorization profile with details of AAD user Ids and group Ids authorized for data plane access. Required.

  • secrets_profile (SecretsProfile) – The cluster secret profile.

  • service_configs_profiles (list[ClusterServiceConfigsProfile]) – The service configs profiles.

  • cluster_access_profile (ClusterAccessProfile) – Cluster access profile.

  • log_analytics_profile (ClusterLogAnalyticsProfile) – Cluster log analytics profile to enable or disable OMS agent for cluster.

  • prometheus_profile (ClusterPrometheusProfile) – Cluster Prometheus profile.

  • ssh_profile (SshProfile) – Ssh profile for the cluster.

  • autoscale_profile (AutoscaleProfile) – This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.

  • ranger_plugin_profile (ClusterRangerPluginProfile) – Cluster Ranger plugin profile.

  • kafka_profile (KafkaProfile) – The Kafka cluster profile.

  • trino_profile (TrinoProfile) – Trino Cluster profile.

  • llap_profile (dict[str, any]) – LLAP cluster profile.

  • flink_profile (FlinkProfile) – The Flink cluster profile.

  • spark_profile (SparkProfile) – The spark cluster profile.

  • ranger_profile (RangerProfile) – The ranger cluster profile.

  • stub_profile (dict[str, any]) – Stub cluster profile.

  • script_action_profiles (list[ScriptActionProfile]) – The script action profile list.

class azure.mgmt.hdinsightcontainers.models.ClusterPrometheusProfile(*, enabled: bool = False, **kwargs: Any)[source]

Bases: Model

Cluster Prometheus profile.

All required parameters must be populated in order to send to server.

Variables:

enabled (bool) – Enable Prometheus for cluster or not. Required.

Keyword Arguments:

enabled (bool) – Enable Prometheus for cluster or not. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterRangerPluginProfile(*, enabled: bool = False, **kwargs: Any)[source]

Bases: Model

Cluster Ranger plugin profile.

All required parameters must be populated in order to send to server.

Variables:

enabled (bool) – Enable Ranger for cluster or not. Required.

Keyword Arguments:

enabled (bool) – Enable Ranger for cluster or not. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterResizeData(*, location: str, tags: Dict[str, str] | None = None, properties: _models.ClusterResizeProperties | None = None, **kwargs: Any)[source]

Bases: TrackedResource

The parameters for resizing a cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterResizeProperties) – Sets the properties. Define cluster resize specific properties.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (ClusterResizeProperties) – Sets the properties. Define cluster resize specific properties.

class azure.mgmt.hdinsightcontainers.models.ClusterResizeProperties(*, target_worker_node_count: int, **kwargs: Any)[source]

Bases: Model

The properties for resizing a cluster.

All required parameters must be populated in order to send to server.

Variables:

target_worker_node_count (int) – Target node count of worker node. Required.

Keyword Arguments:

target_worker_node_count (int) – Target node count of worker node. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterResourceProperties(*, cluster_type: str, compute_profile: _models.ComputeProfile, cluster_profile: _models.ClusterProfile, **kwargs: Any)[source]

Bases: Model

Cluster resource properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • provisioning_state (str or ProvisioningStatus) – Provisioning state of the resource. Known values are: “Accepted”, “Succeeded”, “Canceled”, and “Failed”.

  • cluster_type (str) – The type of cluster. Required.

  • deployment_id (str) – A unique id generated by the RP to identify the resource.

  • compute_profile (ComputeProfile) – The compute profile. Required.

  • cluster_profile (ClusterProfile) – Cluster profile. Required.

  • status (str) – Business status of the resource.

Keyword Arguments:

  • cluster_type (str) – The type of cluster. Required.

  • compute_profile (ComputeProfile) – The compute profile. Required.

  • cluster_profile (ClusterProfile) – Cluster profile. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterServiceConfig(*, component: str, files: List[_models.ClusterConfigFile], **kwargs: Any)[source]

Bases: Model

Cluster configs per component.

All required parameters must be populated in order to send to server.

Variables:

  • component (str) – Name of the component the config files should apply to. Required.

  • files (list[ClusterConfigFile]) – List of Config Files. Required.

Keyword Arguments:

  • component (str) – Name of the component the config files should apply to. Required.

  • files (list[ClusterConfigFile]) – List of Config Files. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterServiceConfigsProfile(*, service_name: str, configs: List[_models.ClusterServiceConfig], **kwargs: Any)[source]

Bases: Model

Cluster service configs.

All required parameters must be populated in order to send to server.

Variables:

  • service_name (str) – Name of the service the configurations should apply to. Required.

  • configs (list[ClusterServiceConfig]) – List of service configs. Required.

Keyword Arguments:

  • service_name (str) – Name of the service the configurations should apply to. Required.

  • configs (list[ClusterServiceConfig]) – List of service configs. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgrade(*, properties: _models.ClusterUpgradeProperties, **kwargs: Any)[source]

Bases: Model

Cluster Upgrade.

All required parameters must be populated in order to send to server.

Variables:

properties (ClusterUpgradeProperties) – Properties of upgrading cluster. Required.

Keyword Arguments:

properties (ClusterUpgradeProperties) – Properties of upgrading cluster. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistory(*, properties: _models.ClusterUpgradeHistoryProperties, **kwargs: Any)[source]

Bases: ProxyResource

Cluster upgrade history.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterUpgradeHistoryProperties) – Properties of cluster upgrade history. Required.

Keyword Arguments:

properties (ClusterUpgradeHistoryProperties) – Properties of cluster upgrade history. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistoryListResult(*, value: List[_models.ClusterUpgradeHistory], **kwargs: Any)[source]

Bases: Model

Represents a list of cluster upgrade history.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • value (list[ClusterUpgradeHistory]) – The list of cluster upgrade history. Required.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ClusterUpgradeHistory]) – The list of cluster upgrade history. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistoryProperties(*, utc_time: str, upgrade_result: str | _models.ClusterUpgradeHistoryUpgradeResultType, **kwargs: Any)[source]

Bases: Model

Properties of cluster upgrade history.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterAksPatchUpgradeHistoryProperties, ClusterInPlaceUpgradeHistoryProperties

All required parameters must be populated in order to send to server.

Variables:

  • upgrade_type (str or ClusterUpgradeHistoryType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, “HotfixUpgradeRollback”, “PatchVersionUpgrade”, and “PatchVersionUpgradeRollback”.

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

Keyword Arguments:

  • utc_time (str) – Time when created this upgrade history. Required.

  • upgrade_result (str or ClusterUpgradeHistoryUpgradeResultType) – Result of this upgrade. Required. Known values are: “Succeed” and “Failed”.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistorySeverityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Severity of this upgrade.

CRITICAL = 'critical'
HIGH = 'high'
LOW = 'low'
MEDIUM = 'medium'
class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistoryType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
HOTFIX_UPGRADE = 'HotfixUpgrade'
HOTFIX_UPGRADE_ROLLBACK = 'HotfixUpgradeRollback'
PATCH_VERSION_UPGRADE = 'PatchVersionUpgrade'
PATCH_VERSION_UPGRADE_ROLLBACK = 'PatchVersionUpgradeRollback'
class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeHistoryUpgradeResultType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Result of this upgrade.

FAILED = 'Failed'
SUCCEED = 'Succeed'
class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeProperties(**kwargs: Any)[source]

Bases: Model

Properties of upgrading cluster.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClusterAKSPatchVersionUpgradeProperties, ClusterInPlaceUpgradeProperties

All required parameters must be populated in order to send to server.

Variables:

upgrade_type (str or ClusterUpgradeType) – Type of upgrade. Required. Known values are: “AKSPatchUpgrade”, “HotfixUpgrade”, and “PatchVersionUpgrade”.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeRollback(*, properties: _models.ClusterUpgradeRollbackProperties, **kwargs: Any)[source]

Bases: Model

Cluster Upgrade.

All required parameters must be populated in order to send to server.

Variables:

properties (ClusterUpgradeRollbackProperties) – Properties for manual rollback of cluster’s upgrade. Required.

Keyword Arguments:

properties (ClusterUpgradeRollbackProperties) – Properties for manual rollback of cluster’s upgrade. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeRollbackProperties(*, upgrade_history: str, **kwargs: Any)[source]

Bases: Model

Properties for manual rollback of cluster’s upgrade.

All required parameters must be populated in order to send to server.

Variables:

upgrade_history (str) – A specific upgrade history to rollback. Required.

Keyword Arguments:

upgrade_history (str) – A specific upgrade history to rollback. Required.

class azure.mgmt.hdinsightcontainers.models.ClusterUpgradeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of upgrade.

AKS_PATCH_UPGRADE = 'AKSPatchUpgrade'
HOTFIX_UPGRADE = 'HotfixUpgrade'
PATCH_VERSION_UPGRADE = 'PatchVersionUpgrade'
class azure.mgmt.hdinsightcontainers.models.ClusterVersion(*, properties: _models.ClusterVersionProperties | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Available cluster version.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • properties (ClusterVersionProperties) – Cluster version properties.

Keyword Arguments:

properties (ClusterVersionProperties) – Cluster version properties.

class azure.mgmt.hdinsightcontainers.models.ClusterVersionProperties(*, cluster_type: str | None = None, cluster_version: str | None = None, oss_version: str | None = None, cluster_pool_version: str | None = None, is_preview: bool = False, **kwargs: Any)[source]

Bases: Model

Cluster version properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • cluster_type (str) – The type of cluster.

  • cluster_version (str) – Version with three part.

  • oss_version (str) – Version with three part.

  • cluster_pool_version (str) – The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string.

  • is_preview (bool) – Indicate if this version is in preview or not.

  • components (list[ClusterComponentsItem]) – Component list of this cluster type and version.

Keyword Arguments:

  • cluster_type (str) – The type of cluster.

  • cluster_version (str) – Version with three part.

  • oss_version (str) – Version with three part.

  • cluster_pool_version (str) – The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string.

  • is_preview (bool) – Indicate if this version is in preview or not.

class azure.mgmt.hdinsightcontainers.models.ClusterVersionsListResult(*, value: List[_models.ClusterVersion] | None = None, **kwargs: Any)[source]

Bases: Model

Represents a list of cluster versions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ClusterVersion]) – The list of cluster versions.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ClusterVersion]) – The list of cluster versions.

class azure.mgmt.hdinsightcontainers.models.ComparisonOperator(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The comparison operator.

GREATER_THAN = 'greaterThan'
GREATER_THAN_OR_EQUAL = 'greaterThanOrEqual'
LESS_THAN = 'lessThan'
LESS_THAN_OR_EQUAL = 'lessThanOrEqual'
class azure.mgmt.hdinsightcontainers.models.ComparisonRule(*, operator: str | _models.ComparisonOperator, threshold: float, **kwargs: Any)[source]

Bases: Model

The comparison rule.

All required parameters must be populated in order to send to server.

Variables:

  • operator (str or ComparisonOperator) – The comparison operator. Required. Known values are: “greaterThan”, “greaterThanOrEqual”, “lessThan”, and “lessThanOrEqual”.

  • threshold (float) – Threshold setting. Required.

Keyword Arguments:

  • operator (str or ComparisonOperator) – The comparison operator. Required. Known values are: “greaterThan”, “greaterThanOrEqual”, “lessThan”, and “lessThanOrEqual”.

  • threshold (float) – Threshold setting. Required.

class azure.mgmt.hdinsightcontainers.models.ComputeProfile(*, nodes: List[_models.NodeProfile], availability_zones: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The compute profile.

All required parameters must be populated in order to send to server.

Variables:

  • nodes (list[NodeProfile]) – The nodes definitions. Required.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

Keyword Arguments:

  • nodes (list[NodeProfile]) – The nodes definitions. Required.

  • availability_zones (list[str]) – The list of Availability zones to use for AKS VMSS nodes.

class azure.mgmt.hdinsightcontainers.models.ComputeResourceDefinition(*, cpu: float, memory: int, **kwargs: Any)[source]

Bases: Model

The cpu and memory requirement definition.

All required parameters must be populated in order to send to server.

Variables:

  • cpu (float) – The required CPU. Required.

  • memory (int) – The required memory in MB, Container memory will be 110 percentile. Required.

Keyword Arguments:

  • cpu (float) – The required CPU. Required.

  • memory (int) – The required memory in MB, Container memory will be 110 percentile. Required.

class azure.mgmt.hdinsightcontainers.models.ConnectivityProfile(*, web: _models.ConnectivityProfileWeb, ssh: List[_models.SshConnectivityEndpoint] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster connectivity profile.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.ConnectivityProfileWeb(*, fqdn: str, private_fqdn: str | None = None, **kwargs: Any)[source]

Bases: WebConnectivityEndpoint

Web connectivity endpoint details.

All required parameters must be populated in order to send to server.

Variables:

  • fqdn (str) – Web connectivity endpoint. Required.

  • private_fqdn (str) – Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.

Keyword Arguments:

  • fqdn (str) – Web connectivity endpoint. Required.

  • private_fqdn (str) – Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.

class azure.mgmt.hdinsightcontainers.models.ContentEncoding(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text.

BASE64 = 'Base64'
NONE = 'None'
class azure.mgmt.hdinsightcontainers.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.hdinsightcontainers.models.CurrentClusterAksVersionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Current AKS version’s status: whether it is deprecated or supported.

DEPRECATED = 'Deprecated'
SUPPORTED = 'Supported'
class azure.mgmt.hdinsightcontainers.models.CurrentClusterPoolAksVersionStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Current AKS version’s status: whether it is deprecated or supported.

DEPRECATED = 'Deprecated'
SUPPORTED = 'Supported'
class azure.mgmt.hdinsightcontainers.models.DataDiskType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Managed Disk Type.

PREMIUM_SSD_LRS = 'Premium_SSD_LRS'
PREMIUM_SSD_V2_LRS = 'Premium_SSD_v2_LRS'
PREMIUM_SSD_ZRS = 'Premium_SSD_ZRS'
STANDARD_HDD_LRS = 'Standard_HDD_LRS'
STANDARD_SSD_LRS = 'Standard_SSD_LRS'
STANDARD_SSD_ZRS = 'Standard_SSD_ZRS'
class azure.mgmt.hdinsightcontainers.models.DbConnectionAuthenticationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization.

IDENTITY_AUTH = 'IdentityAuth'

The managed-identity-based authentication to connect to your Hive metastore database.

SQL_AUTH = 'SqlAuth'

The password-based authentication to connect to your Hive metastore database.

class azure.mgmt.hdinsightcontainers.models.DeploymentMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session.

APPLICATION = 'Application'
SESSION = 'Session'
class azure.mgmt.hdinsightcontainers.models.DiskStorageProfile(*, data_disk_size: int, data_disk_type: str | _models.DataDiskType, **kwargs: Any)[source]

Bases: Model

Kafka disk storage profile.

All required parameters must be populated in order to send to server.

Variables:

  • data_disk_size (int) – Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. Required.

  • data_disk_type (str or DataDiskType) – Managed Disk Type. Required. Known values are: “Standard_HDD_LRS”, “Standard_SSD_LRS”, “Standard_SSD_ZRS”, “Premium_SSD_LRS”, “Premium_SSD_ZRS”, and “Premium_SSD_v2_LRS”.

Keyword Arguments:

  • data_disk_size (int) – Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB. Required.

  • data_disk_type (str or DataDiskType) – Managed Disk Type. Required. Known values are: “Standard_HDD_LRS”, “Standard_SSD_LRS”, “Standard_SSD_ZRS”, “Premium_SSD_LRS”, “Premium_SSD_ZRS”, and “Premium_SSD_v2_LRS”.

class azure.mgmt.hdinsightcontainers.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.hdinsightcontainers.models.ErrorDetail(**kwargs: Any)[source]

Bases: Model

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.hdinsightcontainers.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:

error (ErrorDetail) – The error object.

Keyword Arguments:

error (ErrorDetail) – The error object.

class azure.mgmt.hdinsightcontainers.models.FlinkCatalogOptions(*, hive: _models.FlinkHiveCatalogOption | None = None, **kwargs: Any)[source]

Bases: Model

Flink cluster catalog options.

Variables:

hive (FlinkHiveCatalogOption) – Hive Catalog Option for Flink cluster.

Keyword Arguments:

hive (FlinkHiveCatalogOption) – Hive Catalog Option for Flink cluster.

class azure.mgmt.hdinsightcontainers.models.FlinkHiveCatalogOption(*, metastore_db_connection_url: str, metastore_db_connection_authentication_mode: str | _models.MetastoreDbConnectionAuthenticationMode | None = None, metastore_db_connection_password_secret: str | None = None, metastore_db_connection_user_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Hive Catalog Option for Flink cluster.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.FlinkJobProfile(*, job_jar_directory: str, jar_name: str, upgrade_mode: str | _models.UpgradeMode, entry_class: str | None = None, args: str | None = None, save_point_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.

All required parameters must be populated in order to send to server.

Variables:

  • job_jar_directory (str) – A string property that specifies the directory where the job JAR is located. Required.

  • jar_name (str) – A string property that represents the name of the job JAR. Required.

  • entry_class (str) – A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.

  • args (str) – A string property representing additional JVM arguments for the Flink job. It should be space separated value.

  • save_point_name (str) – A string property that represents the name of the savepoint for the Flink job.

  • upgrade_mode (str or UpgradeMode) – A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. Required. Known values are: “STATELESS_UPDATE”, “UPDATE”, and “LAST_STATE_UPDATE”.

Keyword Arguments:

  • job_jar_directory (str) – A string property that specifies the directory where the job JAR is located. Required.

  • jar_name (str) – A string property that represents the name of the job JAR. Required.

  • entry_class (str) – A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.

  • args (str) – A string property representing additional JVM arguments for the Flink job. It should be space separated value.

  • save_point_name (str) – A string property that represents the name of the savepoint for the Flink job.

  • upgrade_mode (str or UpgradeMode) – A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE. Required. Known values are: “STATELESS_UPDATE”, “UPDATE”, and “LAST_STATE_UPDATE”.

class azure.mgmt.hdinsightcontainers.models.FlinkJobProperties(*, run_id: str | None = None, job_name: str | None = None, job_jar_directory: str | None = None, jar_name: str | None = None, entry_class: str | None = None, args: str | None = None, save_point_name: str | None = None, action: str | _models.Action | None = None, flink_configuration: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: ClusterJobProperties

Properties of flink job.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • job_type (str or JobType) – Type of cluster job. Required. “FlinkJob”

  • run_id (str) – Run id of job.

  • job_name (str) – Name of job.

  • job_jar_directory (str) – A string property that specifies the directory where the job JAR is located.

  • jar_name (str) – A string property that represents the name of the job JAR.

  • entry_class (str) – A string property that specifies the entry class for the Flink job.

  • args (str) – A string property representing additional JVM arguments for the Flink job. It should be space separated value.

  • save_point_name (str) – A string property that represents the name of the savepoint for the Flink job.

  • action (str or Action) – A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE. Known values are: “NEW”, “UPDATE”, “STATELESS_UPDATE”, “STOP”, “START”, “CANCEL”, “SAVEPOINT”, “LIST_SAVEPOINT”, “DELETE”, “LAST_STATE_UPDATE”, and “RE_LAUNCH”.

  • flink_configuration (dict[str, str]) – Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.

  • job_id (str) – Unique id for identifying a job.

  • status (str) – Status of job.

  • job_output (str) – Output of job.

  • action_result (str) – Action result of job.

  • last_save_point (str) – The last savepoint.

Keyword Arguments:

  • run_id (str) – Run id of job.

  • job_name (str) – Name of job.

  • job_jar_directory (str) – A string property that specifies the directory where the job JAR is located.

  • jar_name (str) – A string property that represents the name of the job JAR.

  • entry_class (str) – A string property that specifies the entry class for the Flink job.

  • args (str) – A string property representing additional JVM arguments for the Flink job. It should be space separated value.

  • save_point_name (str) – A string property that represents the name of the savepoint for the Flink job.

  • action (str or Action) – A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE. Known values are: “NEW”, “UPDATE”, “STATELESS_UPDATE”, “STOP”, “START”, “CANCEL”, “SAVEPOINT”, “LIST_SAVEPOINT”, “DELETE”, “LAST_STATE_UPDATE”, and “RE_LAUNCH”.

  • flink_configuration (dict[str, str]) – Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.

class azure.mgmt.hdinsightcontainers.models.FlinkProfile(*, storage: _models.FlinkStorageProfile, job_manager: _models.ComputeResourceDefinition, task_manager: _models.ComputeResourceDefinition, num_replicas: int | None = None, history_server: _models.ComputeResourceDefinition | None = None, catalog_options: _models.FlinkCatalogOptions | None = None, deployment_mode: str | _models.DeploymentMode | None = None, job_spec: _models.FlinkJobProfile | None = None, **kwargs: Any)[source]

Bases: Model

The Flink cluster profile.

All required parameters must be populated in order to send to server.

Variables:

  • storage (FlinkStorageProfile) – The storage profile. Required.

  • num_replicas (int) – The number of task managers.

  • job_manager (ComputeResourceDefinition) – Job Manager container/ process CPU and memory requirements. Required.

  • history_server (ComputeResourceDefinition) – History Server container/ process CPU and memory requirements.

  • task_manager (ComputeResourceDefinition) – Task Manager container/ process CPU and memory requirements. Required.

  • catalog_options (FlinkCatalogOptions) – Flink cluster catalog options.

  • deployment_mode (str or DeploymentMode) – A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session. Known values are: “Application” and “Session”.

  • job_spec (FlinkJobProfile) – Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.

Keyword Arguments:

  • storage (FlinkStorageProfile) – The storage profile. Required.

  • num_replicas (int) – The number of task managers.

  • job_manager (ComputeResourceDefinition) – Job Manager container/ process CPU and memory requirements. Required.

  • history_server (ComputeResourceDefinition) – History Server container/ process CPU and memory requirements.

  • task_manager (ComputeResourceDefinition) – Task Manager container/ process CPU and memory requirements. Required.

  • catalog_options (FlinkCatalogOptions) – Flink cluster catalog options.

  • deployment_mode (str or DeploymentMode) – A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session. Known values are: “Application” and “Session”.

  • job_spec (FlinkJobProfile) – Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.

class azure.mgmt.hdinsightcontainers.models.FlinkStorageProfile(*, storage_uri: str, storagekey: str | None = None, **kwargs: Any)[source]

Bases: Model

The storage profile.

All required parameters must be populated in order to send to server.

Variables:

  • storage_uri (str) – Storage account uri which is used for savepoint and checkpoint state. Required.

  • storagekey (str) – Storage key is only required for wasb(s) storage.

Keyword Arguments:

  • storage_uri (str) – Storage account uri which is used for savepoint and checkpoint state. Required.

  • storagekey (str) – Storage key is only required for wasb(s) storage.

class azure.mgmt.hdinsightcontainers.models.HiveCatalogOption(*, catalog_name: str, metastore_db_connection_url: str, metastore_warehouse_dir: str, metastore_db_connection_authentication_mode: str | _models.MetastoreDbConnectionAuthenticationMode | None = None, metastore_db_connection_password_secret: str | None = None, metastore_db_connection_user_name: str | None = None, **kwargs: Any)[source]

Bases: Model

Hive Catalog Option.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.IdentityProfile(*, msi_resource_id: str, msi_client_id: str, msi_object_id: str, **kwargs: Any)[source]

Bases: Model

Identity Profile with details of an MSI.

All required parameters must be populated in order to send to server.

Variables:

  • msi_resource_id (str) – ResourceId of the MSI. Required.

  • msi_client_id (str) – ClientId of the MSI. Required.

  • msi_object_id (str) – ObjectId of the MSI. Required.

Keyword Arguments:

  • msi_resource_id (str) – ResourceId of the MSI. Required.

  • msi_client_id (str) – ClientId of the MSI. Required.

  • msi_object_id (str) – ObjectId of the MSI. Required.

class azure.mgmt.hdinsightcontainers.models.IpTag(*, ip_tag_type: str, tag: str, **kwargs: Any)[source]

Bases: Model

Contains the IpTag associated with the public IP address.

All required parameters must be populated in order to send to server.

Variables:

  • ip_tag_type (str) – Gets or sets the ipTag type: Example FirstPartyUsage. Required.

  • tag (str) – Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc. Required.

Keyword Arguments:

  • ip_tag_type (str) – Gets or sets the ipTag type: Example FirstPartyUsage. Required.

  • tag (str) – Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc. Required.

class azure.mgmt.hdinsightcontainers.models.JobType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of cluster job.

class azure.mgmt.hdinsightcontainers.models.KafkaConnectivityEndpoints(*, bootstrap_server_endpoint: str | None = None, broker_endpoints: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Kafka bootstrap server and broker related connectivity endpoints.

Variables:

  • bootstrap_server_endpoint (str) – bootstrap server connectivity endpoint.

  • broker_endpoints (list[str]) – Kafka broker endpoint list.

Keyword Arguments:

  • bootstrap_server_endpoint (str) – bootstrap server connectivity endpoint.

  • broker_endpoints (list[str]) – Kafka broker endpoint list.

class azure.mgmt.hdinsightcontainers.models.KafkaProfile(*, disk_storage: _models.DiskStorageProfile, enable_k_raft: bool = True, enable_public_endpoints: bool = False, remote_storage_uri: str | None = None, **kwargs: Any)[source]

Bases: Model

The Kafka cluster profile.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • enable_k_raft (bool) – Expose Kafka cluster in KRaft mode.

  • enable_public_endpoints (bool) – Expose worker nodes as public endpoints.

  • remote_storage_uri (str) – Fully qualified path of Azure Storage container used for Tiered Storage.

  • disk_storage (DiskStorageProfile) – Kafka disk storage profile. Required.

  • connectivity_endpoints (KafkaConnectivityEndpoints) – Kafka bootstrap server and brokers related connectivity endpoints.

Keyword Arguments:

  • enable_k_raft (bool) – Expose Kafka cluster in KRaft mode.

  • enable_public_endpoints (bool) – Expose worker nodes as public endpoints.

  • remote_storage_uri (str) – Fully qualified path of Azure Storage container used for Tiered Storage.

  • disk_storage (DiskStorageProfile) – Kafka disk storage profile. Required.

class azure.mgmt.hdinsightcontainers.models.KeyVaultObjectType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of key vault object: secret, key or certificate.

CERTIFICATE = 'Certificate'
KEY = 'Key'
SECRET = 'Secret'
class azure.mgmt.hdinsightcontainers.models.LibraryManagementAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The library management action.

INSTALL = 'Install'
UNINSTALL = 'Uninstall'
class azure.mgmt.hdinsightcontainers.models.LoadBasedConfig(*, min_nodes: int, max_nodes: int, scaling_rules: List[_models.ScalingRule], poll_interval: int | None = None, cooldown_period: int | None = None, **kwargs: Any)[source]

Bases: Model

Profile of load based Autoscale.

All required parameters must be populated in order to send to server.

Variables:

  • min_nodes (int) – User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. Required.

  • max_nodes (int) – User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. Required.

  • poll_interval (int) – User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation.

  • cooldown_period (int) – This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds.

  • scaling_rules (list[ScalingRule]) – The scaling rules. Required.

Keyword Arguments:

  • min_nodes (int) – User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. Required.

  • max_nodes (int) – User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes. Required.

  • poll_interval (int) – User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation.

  • cooldown_period (int) – This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds.

  • scaling_rules (list[ScalingRule]) – The scaling rules. Required.

class azure.mgmt.hdinsightcontainers.models.ManagedIdentityProfile(*, identity_list: List[_models.ManagedIdentitySpec], **kwargs: Any)[source]

Bases: Model

The details of managed identity.

All required parameters must be populated in order to send to server.

Variables:

identity_list (list[ManagedIdentitySpec]) – The list of managed identity. Required.

Keyword Arguments:

identity_list (list[ManagedIdentitySpec]) – The list of managed identity. Required.

class azure.mgmt.hdinsightcontainers.models.ManagedIdentitySpec(*, type: str | _models.ManagedIdentityType, resource_id: str, client_id: str, object_id: str, **kwargs: Any)[source]

Bases: Model

The details of a managed identity.

All required parameters must be populated in order to send to server.

Variables:

  • type (str or ManagedIdentityType) – The type of managed identity. Required. Known values are: “cluster”, “user”, and “internal”.

  • resource_id (str) – ResourceId of the managed identity. Required.

  • client_id (str) – ClientId of the managed identity. Required.

  • object_id (str) – ObjectId of the managed identity. Required.

Keyword Arguments:

  • type (str or ManagedIdentityType) – The type of managed identity. Required. Known values are: “cluster”, “user”, and “internal”.

  • resource_id (str) – ResourceId of the managed identity. Required.

  • client_id (str) – ClientId of the managed identity. Required.

  • object_id (str) – ObjectId of the managed identity. Required.

class azure.mgmt.hdinsightcontainers.models.ManagedIdentityType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of managed identity.

CLUSTER = 'cluster'
INTERNAL = 'internal'
USER = 'user'
class azure.mgmt.hdinsightcontainers.models.MavenLibraryProperties(*, group_id: str, name: str, remarks: str | None = None, version: str | None = None, **kwargs: Any)[source]

Bases: ClusterLibraryProperties

Properties of a Maven library in the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • type (str or Type) – Type of the library. Required. Known values are: “pypi” and “maven”.

  • remarks (str) – Remark of the latest library management operation.

  • timestamp (datetime) – Timestamp of the latest library management operation.

  • status (str or Status) – Status of the library. Known values are: “INSTALLING”, “INSTALLED”, “INSTALL_FAILED”, “UNINSTALLING”, and “UNINSTALL_FAILED”.

  • message (str) – Error message of the library operation when a failure occurs.

  • group_id (str) – GroupId of the Maven package. Required.

  • name (str) – ArtifactId of the Maven package. Required.

  • version (str) – Version of the Maven package.

Keyword Arguments:

  • remarks (str) – Remark of the latest library management operation.

  • group_id (str) – GroupId of the Maven package. Required.

  • name (str) – ArtifactId of the Maven package. Required.

  • version (str) – Version of the Maven package.

class azure.mgmt.hdinsightcontainers.models.MetastoreDbConnectionAuthenticationMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization.

IDENTITY_AUTH = 'IdentityAuth'

The managed-identity-based authentication to connect to your Hive metastore database.

SQL_AUTH = 'SqlAuth'

The password-based authentication to connect to your Hive metastore database.

class azure.mgmt.hdinsightcontainers.models.NameAvailabilityParameters(*, name: str | None = None, type: str | None = None, **kwargs: Any)[source]

Bases: Model

Details of check name availability request body.

Variables:

  • name (str) – Name for checking availability.

  • type (str) – The resource type in Microsoft.HDInsight.

Keyword Arguments:

  • name (str) – Name for checking availability.

  • type (str) – The resource type in Microsoft.HDInsight.

class azure.mgmt.hdinsightcontainers.models.NameAvailabilityResult(*, name_available: bool | None = None, reason: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

Result of check name availability.

Variables:

  • name_available (bool) – Indicator of availability of the Microsoft.HDInsight resource name.

  • reason (str) – The reason of unavailability.

  • message (str) – The error message of unavailability.

Keyword Arguments:

  • name_available (bool) – Indicator of availability of the Microsoft.HDInsight resource name.

  • reason (str) – The reason of unavailability.

  • message (str) – The error message of unavailability.

class azure.mgmt.hdinsightcontainers.models.NodeProfile(*, type: str, vm_size: str, count: int, **kwargs: Any)[source]

Bases: Model

The node profile.

All required parameters must be populated in order to send to server.

Variables:

  • type (str) – The node type. Required.

  • vm_size (str) – The virtual machine SKU. Required.

  • count (int) – The number of virtual machines. Required.

Keyword Arguments:

  • type (str) – The node type. Required.

  • vm_size (str) – The virtual machine SKU. Required.

  • count (int) – The number of virtual machines. Required.

class azure.mgmt.hdinsightcontainers.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

  • is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.

  • display (OperationDisplay) – Localized display information for this particular operation.

  • origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

  • action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments:

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.hdinsightcontainers.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

Localized display information for this particular operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

  • resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

  • operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

  • description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.hdinsightcontainers.models.OperationListResult(**kwargs: Any)[source]

Bases: Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Operation]) – List of operations supported by the resource provider.

  • next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.hdinsightcontainers.models.Origin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'
USER = 'user'
USER_SYSTEM = 'user,system'
class azure.mgmt.hdinsightcontainers.models.OutboundType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

This can only be set at cluster pool creation time and cannot be changed later.

LOAD_BALANCER = 'loadBalancer'

The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type ‘loadBalancer’.

USER_DEFINED_ROUTING = 'userDefinedRouting'

Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration.

class azure.mgmt.hdinsightcontainers.models.ProvisioningStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Provisioning state of the resource.

ACCEPTED = 'Accepted'
CANCELED = 'Canceled'
FAILED = 'Failed'
SUCCEEDED = 'Succeeded'
class azure.mgmt.hdinsightcontainers.models.ProxyResource(**kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.hdinsightcontainers.models.PyPiLibraryProperties(*, name: str, remarks: str | None = None, version: str | None = None, **kwargs: Any)[source]

Bases: ClusterLibraryProperties

Properties of a PyPi library in the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • type (str or Type) – Type of the library. Required. Known values are: “pypi” and “maven”.

  • remarks (str) – Remark of the latest library management operation.

  • timestamp (datetime) – Timestamp of the latest library management operation.

  • status (str or Status) – Status of the library. Known values are: “INSTALLING”, “INSTALLED”, “INSTALL_FAILED”, “UNINSTALLING”, and “UNINSTALL_FAILED”.

  • message (str) – Error message of the library operation when a failure occurs.

  • name (str) – Name of the PyPi package. Required.

  • version (str) – Version of the PyPi package.

Keyword Arguments:

  • remarks (str) – Remark of the latest library management operation.

  • name (str) – Name of the PyPi package. Required.

  • version (str) – Version of the PyPi package.

class azure.mgmt.hdinsightcontainers.models.RangerAdminSpec(*, admins: List[str], database: _models.RangerAdminSpecDatabase, **kwargs: Any)[source]

Bases: Model

Specification for the Ranger Admin service.

All required parameters must be populated in order to send to server.

Variables:

  • admins (list[str]) – List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. Required.

  • database (RangerAdminSpecDatabase) – Required.

Keyword Arguments:

  • admins (list[str]) – List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users. Required.

  • database (RangerAdminSpecDatabase) – Required.

class azure.mgmt.hdinsightcontainers.models.RangerAdminSpecDatabase(*, host: str, name: str, password_secret_ref: str | None = None, username: str | None = None, **kwargs: Any)[source]

Bases: Model

RangerAdminSpecDatabase.

All required parameters must be populated in order to send to server.

Variables:

  • host (str) – The database URL. Required.

  • name (str) – The database name. Required.

  • password_secret_ref (str) – Reference for the database password.

  • username (str) – The name of the database user.

Keyword Arguments:

  • host (str) – The database URL. Required.

  • name (str) – The database name. Required.

  • password_secret_ref (str) – Reference for the database password.

  • username (str) – The name of the database user.

class azure.mgmt.hdinsightcontainers.models.RangerAuditSpec(*, storage_account: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties required to describe audit log storage.

Variables:

storage_account (str) – Azure storage location of the blobs. MSI should have read/write access to this Storage account.

Keyword Arguments:

storage_account (str) – Azure storage location of the blobs. MSI should have read/write access to this Storage account.

class azure.mgmt.hdinsightcontainers.models.RangerProfile(*, ranger_admin: _models.RangerAdminSpec, ranger_usersync: _models.RangerUsersyncSpec, ranger_audit: _models.RangerAuditSpec | None = None, **kwargs: Any)[source]

Bases: Model

The ranger cluster profile.

All required parameters must be populated in order to send to server.

Variables:

  • ranger_admin (RangerAdminSpec) – Specification for the Ranger Admin service. Required.

  • ranger_audit (RangerAuditSpec) – Properties required to describe audit log storage.

  • ranger_usersync (RangerUsersyncSpec) – Specification for the Ranger Usersync service. Required.

Keyword Arguments:

  • ranger_admin (RangerAdminSpec) – Specification for the Ranger Admin service. Required.

  • ranger_audit (RangerAuditSpec) – Properties required to describe audit log storage.

  • ranger_usersync (RangerUsersyncSpec) – Specification for the Ranger Usersync service. Required.

class azure.mgmt.hdinsightcontainers.models.RangerUsersyncMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

User & groups can be synced automatically or via a static list that’s refreshed.

AUTOMATIC = 'automatic'
STATIC = 'static'
class azure.mgmt.hdinsightcontainers.models.RangerUsersyncSpec(*, enabled: bool = True, groups: List[str] | None = None, mode: str | _models.RangerUsersyncMode = 'automatic', user_mapping_location: str | None = None, users: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Specification for the Ranger Usersync service.

Variables:

  • enabled (bool) – Denotes whether usersync service should be enabled.

  • groups (list[str]) – List of groups that should be synced. These group names should match the object id of the respective AAD groups.

  • mode (str or RangerUsersyncMode) – User & groups can be synced automatically or via a static list that’s refreshed. Known values are: “static” and “automatic”.

  • user_mapping_location (str) – Azure storage location of a mapping file that lists user & group associations.

  • users (list[str]) – List of user names that should be synced. These usernames should match the User principal name of the respective AAD users.

Keyword Arguments:

  • enabled (bool) – Denotes whether usersync service should be enabled.

  • groups (list[str]) – List of groups that should be synced. These group names should match the object id of the respective AAD groups.

  • mode (str or RangerUsersyncMode) – User & groups can be synced automatically or via a static list that’s refreshed. Known values are: “static” and “automatic”.

  • user_mapping_location (str) – Azure storage location of a mapping file that lists user & group associations.

  • users (list[str]) – List of user names that should be synced. These usernames should match the User principal name of the respective AAD users.

class azure.mgmt.hdinsightcontainers.models.Resource(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.hdinsightcontainers.models.ScaleActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The action type.

SCALEDOWN = 'scaledown'
SCALEUP = 'scaleup'
class azure.mgmt.hdinsightcontainers.models.ScalingRule(*, action_type: str | _models.ScaleActionType, evaluation_count: int, scaling_metric: str, comparison_rule: _models.ComparisonRule, **kwargs: Any)[source]

Bases: Model

The scaling rule.

All required parameters must be populated in order to send to server.

Variables:

  • action_type (str or ScaleActionType) – The action type. Required. Known values are: “scaleup” and “scaledown”.

  • evaluation_count (int) – This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. Required.

  • scaling_metric (str) – Metrics name for individual workloads. For example: cpu. Required.

  • comparison_rule (ComparisonRule) – The comparison rule. Required.

Keyword Arguments:

  • action_type (str or ScaleActionType) – The action type. Required. Known values are: “scaleup” and “scaledown”.

  • evaluation_count (int) – This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered. Required.

  • scaling_metric (str) – Metrics name for individual workloads. For example: cpu. Required.

  • comparison_rule (ComparisonRule) – The comparison rule. Required.

class azure.mgmt.hdinsightcontainers.models.Schedule(*, start_time: str, end_time: str, count: int, days: List[str | _models.ScheduleDay], **kwargs: Any)[source]

Bases: Model

Schedule definition.

All required parameters must be populated in order to send to server.

Variables:

  • start_time (str) – User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). Required.

  • end_time (str) – User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). Required.

  • count (int) – User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. Required.

  • days (list[str or ScheduleDay]) – User has to set the days where schedule has to be set for autoscale operation. Required.

Keyword Arguments:

  • start_time (str) – User has to set the start time of current schedule configuration, format like 10:30 (HH:MM). Required.

  • end_time (str) – User has to set the end time of current schedule configuration, format like 10:30 (HH:MM). Required.

  • count (int) – User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer. Required.

  • days (list[str or ScheduleDay]) – User has to set the days where schedule has to be set for autoscale operation. Required.

class azure.mgmt.hdinsightcontainers.models.ScheduleBasedConfig(*, time_zone: str, default_count: int, schedules: List[_models.Schedule], **kwargs: Any)[source]

Bases: Model

Profile of schedule based Autoscale.

All required parameters must be populated in order to send to server.

Variables:

  • time_zone (str) – User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. Required.

  • default_count (int) – Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down). Required.

  • schedules (list[Schedule]) – This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). Required.

Keyword Arguments:

  • time_zone (str) – User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration. Required.

  • default_count (int) – Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down). Required.

  • schedules (list[Schedule]) – This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end). Required.

class azure.mgmt.hdinsightcontainers.models.ScheduleDay(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

ScheduleDay.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.hdinsightcontainers.models.ScriptActionProfile(*, type: str, name: str, url: str, services: List[str], parameters: str | None = None, timeout_in_minutes: int | None = None, should_persist: bool = True, **kwargs: Any)[source]

Bases: Model

The script action profile.

All required parameters must be populated in order to send to server.

Variables:

  • type (str) – Type of the script action. Supported type is bash scripts. Required.

  • name (str) – Script name. Required.

  • url (str) – Url of the script file. Required.

  • parameters (str) – Additional parameters for the script action. It should be space-separated list of arguments required for script execution.

  • services (list[str]) – List of services to apply the script action. Required.

  • timeout_in_minutes (int) – Timeout duration for the script action in minutes.

  • should_persist (bool) – Specify if the script should persist on the cluster.

Keyword Arguments:

  • type (str) – Type of the script action. Supported type is bash scripts. Required.

  • name (str) – Script name. Required.

  • url (str) – Url of the script file. Required.

  • parameters (str) – Additional parameters for the script action. It should be space-separated list of arguments required for script execution.

  • services (list[str]) – List of services to apply the script action. Required.

  • timeout_in_minutes (int) – Timeout duration for the script action in minutes.

  • should_persist (bool) – Specify if the script should persist on the cluster.

class azure.mgmt.hdinsightcontainers.models.SecretReference(*, reference_name: str, type: str | _models.KeyVaultObjectType, key_vault_object_name: str, version: str | None = None, **kwargs: Any)[source]

Bases: Model

Secret reference and corresponding properties of a key vault secret.

All required parameters must be populated in order to send to server.

Variables:

  • reference_name (str) – Reference name of the secret to be used in service configs. Required.

  • type (str or KeyVaultObjectType) – Type of key vault object: secret, key or certificate. Required. Known values are: “Key”, “Secret”, and “Certificate”.

  • version (str) – Version of the secret in key vault.

  • key_vault_object_name (str) – Object identifier name of the secret in key vault. Required.

Keyword Arguments:

  • reference_name (str) – Reference name of the secret to be used in service configs. Required.

  • type (str or KeyVaultObjectType) – Type of key vault object: secret, key or certificate. Required. Known values are: “Key”, “Secret”, and “Certificate”.

  • version (str) – Version of the secret in key vault.

  • key_vault_object_name (str) – Object identifier name of the secret in key vault. Required.

class azure.mgmt.hdinsightcontainers.models.SecretsProfile(*, key_vault_resource_id: str, secrets: List[_models.SecretReference] | None = None, **kwargs: Any)[source]

Bases: Model

The cluster secret profile.

All required parameters must be populated in order to send to server.

Variables:

  • key_vault_resource_id (str) – Name of the user Key Vault where all the cluster specific user secrets are stored. Required.

  • secrets (list[SecretReference]) – Properties of Key Vault secret.

Keyword Arguments:

  • key_vault_resource_id (str) – Name of the user Key Vault where all the cluster specific user secrets are stored. Required.

  • secrets (list[SecretReference]) – Properties of Key Vault secret.

class azure.mgmt.hdinsightcontainers.models.ServiceConfigListResult(*, value: List[_models.ServiceConfigResult] | None = None, **kwargs: Any)[source]

Bases: Model

Cluster instance service configs api response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[ServiceConfigResult]) – Cluster instance service config array.

  • next_link (str) – The link (url) to the next page of results.

Keyword Arguments:

value (list[ServiceConfigResult]) – Cluster instance service config array.

class azure.mgmt.hdinsightcontainers.models.ServiceConfigListResultProperties(*, service_name: str, file_name: str, component_name: str, content: str | None = None, type: str | None = None, path: str | None = None, custom_keys: Dict[str, str] | None = None, default_keys: Dict[str, _models.ServiceConfigListResultValueEntity] | None = None, **kwargs: Any)[source]

Bases: Model

Service config response.

All required parameters must be populated in order to send to server.

Variables:

  • service_name (str) – Service Config Name. Required.

  • file_name (str) – File Name. Required.

  • content (str) – Content in the service config file.

  • component_name (str) – Component Name. Required.

  • type (str) – Config type.

  • path (str) – Config file path.

  • custom_keys (dict[str, str]) – The custom keys.

  • default_keys (dict[str, ServiceConfigListResultValueEntity]) – The default keys.

Keyword Arguments:

  • service_name (str) – Service Config Name. Required.

  • file_name (str) – File Name. Required.

  • content (str) – Content in the service config file.

  • component_name (str) – Component Name. Required.

  • type (str) – Config type.

  • path (str) – Config file path.

  • custom_keys (dict[str, str]) – The custom keys.

  • default_keys (dict[str, ServiceConfigListResultValueEntity]) – The default keys.

class azure.mgmt.hdinsightcontainers.models.ServiceConfigListResultValueEntity(*, value: str, description: str | None = None, **kwargs: Any)[source]

Bases: Model

Default config details.

All required parameters must be populated in order to send to server.

Variables:

  • value (str) – Config value. Required.

  • description (str) – Config description.

Keyword Arguments:

  • value (str) – Config value. Required.

  • description (str) – Config description.

class azure.mgmt.hdinsightcontainers.models.ServiceConfigResult(*, properties: _models.ServiceConfigResultProperties | None = None, **kwargs: Any)[source]

Bases: Model

Cluster instance service config.

Variables:

properties (ServiceConfigResultProperties) – Cluster instance service config properties.

Keyword Arguments:

properties (ServiceConfigResultProperties) – Cluster instance service config properties.

class azure.mgmt.hdinsightcontainers.models.ServiceConfigResultProperties(*, service_name: str, file_name: str, component_name: str, content: str | None = None, type: str | None = None, path: str | None = None, custom_keys: Dict[str, str] | None = None, default_keys: Dict[str, _models.ServiceConfigListResultValueEntity] | None = None, **kwargs: Any)[source]

Bases: ServiceConfigListResultProperties

Cluster instance service config properties.

All required parameters must be populated in order to send to server.

Variables:

  • service_name (str) – Service Config Name. Required.

  • file_name (str) – File Name. Required.

  • content (str) – Content in the service config file.

  • component_name (str) – Component Name. Required.

  • type (str) – Config type.

  • path (str) – Config file path.

  • custom_keys (dict[str, str]) – The custom keys.

  • default_keys (dict[str, ServiceConfigListResultValueEntity]) – The default keys.

Keyword Arguments:

  • service_name (str) – Service Config Name. Required.

  • file_name (str) – File Name. Required.

  • content (str) – Content in the service config file.

  • component_name (str) – Component Name. Required.

  • type (str) – Config type.

  • path (str) – Config file path.

  • custom_keys (dict[str, str]) – The custom keys.

  • default_keys (dict[str, ServiceConfigListResultValueEntity]) – The default keys.

class azure.mgmt.hdinsightcontainers.models.ServiceStatus(*, kind: str, ready: str, message: str | None = None, **kwargs: Any)[source]

Bases: Model

Describes the status of a service of a HDInsight on AKS cluster.

All required parameters must be populated in order to send to server.

Variables:

  • kind (str) – Kind of the service. E.g. “Zookeeper”. Required.

  • ready (str) – Indicates if the service is ready / healthy. Values can be “true”, “false”, “unknown” or anything else. Required.

  • message (str) – A message describing the error if any.

Keyword Arguments:

  • kind (str) – Kind of the service. E.g. “Zookeeper”. Required.

  • ready (str) – Indicates if the service is ready / healthy. Values can be “true”, “false”, “unknown” or anything else. Required.

  • message (str) – A message describing the error if any.

class azure.mgmt.hdinsightcontainers.models.Severity(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Severity of this upgrade.

CRITICAL = 'critical'
HIGH = 'high'
LOW = 'low'
MEDIUM = 'medium'
class azure.mgmt.hdinsightcontainers.models.SparkMetastoreSpec(*, db_server_host: str, db_name: str, db_connection_authentication_mode: str | _models.DbConnectionAuthenticationMode = 'IdentityAuth', db_user_name: str | None = None, db_password_secret_name: str | None = None, key_vault_id: str | None = None, thrift_url: str | None = None, **kwargs: Any)[source]

Bases: Model

The metastore specification for Spark cluster.

All required parameters must be populated in order to send to server.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.SparkProfile(*, default_storage_url: str | None = None, metastore_spec: _models.SparkMetastoreSpec | None = None, user_plugins_spec: _models.SparkUserPlugins | None = None, **kwargs: Any)[source]

Bases: Model

The spark cluster profile.

Variables:

  • default_storage_url (str) – The default storage URL.

  • metastore_spec (SparkMetastoreSpec) – The metastore specification for Spark cluster.

  • user_plugins_spec (SparkUserPlugins) – Spark user plugins spec.

Keyword Arguments:

  • default_storage_url (str) – The default storage URL.

  • metastore_spec (SparkMetastoreSpec) – The metastore specification for Spark cluster.

  • user_plugins_spec (SparkUserPlugins) – Spark user plugins spec.

class azure.mgmt.hdinsightcontainers.models.SparkUserPlugin(*, path: str, **kwargs: Any)[source]

Bases: Model

Spark user plugin.

All required parameters must be populated in order to send to server.

Variables:

path (str) – Fully qualified path to the folder containing the plugins. Required.

Keyword Arguments:

path (str) – Fully qualified path to the folder containing the plugins. Required.

class azure.mgmt.hdinsightcontainers.models.SparkUserPlugins(*, plugins: List[_models.SparkUserPlugin] | None = None, **kwargs: Any)[source]

Bases: Model

Spark user plugins spec.

Variables:

plugins (list[SparkUserPlugin]) – Spark user plugins.

Keyword Arguments:

plugins (list[SparkUserPlugin]) – Spark user plugins.

class azure.mgmt.hdinsightcontainers.models.SshConnectivityEndpoint(*, endpoint: str, private_ssh_endpoint: str | None = None, **kwargs: Any)[source]

Bases: Model

SSH connectivity endpoint details.

All required parameters must be populated in order to send to server.

Variables:

  • endpoint (str) – SSH connectivity endpoint. Required.

  • private_ssh_endpoint (str) – Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true.

Keyword Arguments:

  • endpoint (str) – SSH connectivity endpoint. Required.

  • private_ssh_endpoint (str) – Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true.

class azure.mgmt.hdinsightcontainers.models.SshProfile(*, count: int, vm_size: str | None = None, **kwargs: Any)[source]

Bases: Model

Ssh profile for the cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • count (int) – Number of ssh pods per cluster. Required.

  • pod_prefix (str) – Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at <clusterFqdn>/<sshBasePath>/<prefix>-<number>.

  • vm_size (str) – The virtual machine SKU.

Keyword Arguments:

  • count (int) – Number of ssh pods per cluster. Required.

  • vm_size (str) – The virtual machine SKU.

class azure.mgmt.hdinsightcontainers.models.Status(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Status of the library.

INSTALLED = 'INSTALLED'
INSTALLING = 'INSTALLING'
INSTALL_FAILED = 'INSTALL_FAILED'
UNINSTALLING = 'UNINSTALLING'
UNINSTALL_FAILED = 'UNINSTALL_FAILED'
class azure.mgmt.hdinsightcontainers.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.hdinsightcontainers.models.TagsObject(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Tags object for patch operations.

Variables:

tags (dict[str, str]) – Resource tags.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.

class azure.mgmt.hdinsightcontainers.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. E.g. “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.hdinsightcontainers.models.TrinoCoordinator(*, debug: _models.TrinoDebugConfig | None = None, high_availability_enabled: bool = True, **kwargs: Any)[source]

Bases: Model

Trino Coordinator.

Variables:

  • debug (TrinoDebugConfig) – Trino debug configuration.

  • high_availability_enabled (bool) – The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.

Keyword Arguments:

  • debug (TrinoDebugConfig) – Trino debug configuration.

  • high_availability_enabled (bool) – The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.

class azure.mgmt.hdinsightcontainers.models.TrinoDebugConfig(*, enable: bool = False, port: int = 8008, suspend: bool = False, **kwargs: Any)[source]

Bases: Model

Trino debug configuration.

Variables:

  • enable (bool) – The flag that if enable debug or not.

  • port (int) – The debug port.

  • suspend (bool) – The flag that if suspend debug or not.

Keyword Arguments:

  • enable (bool) – The flag that if enable debug or not.

  • port (int) – The debug port.

  • suspend (bool) – The flag that if suspend debug or not.

class azure.mgmt.hdinsightcontainers.models.TrinoProfile(*, catalog_options: _models.CatalogOptions | None = None, coordinator: _models.TrinoCoordinator | None = None, user_plugins_spec: _models.TrinoUserPlugins | None = None, user_telemetry_spec: _models.TrinoUserTelemetry | None = None, worker: _models.TrinoWorker | None = None, **kwargs: Any)[source]

Bases: Model

Trino Cluster profile.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.TrinoTelemetryConfig(*, hivecatalog_name: str | None = None, hivecatalog_schema: str = 'trinologs', partition_retention_in_days: int = 365, path: str | None = None, **kwargs: Any)[source]

Bases: Model

Trino user telemetry definition.

Variables:

  • hivecatalog_name (str) – Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.

  • hivecatalog_schema (str) – Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.

  • partition_retention_in_days (int) – Retention period for query log table partitions, this doesn’t have any affect on actual data.

  • path (str) – Azure storage location of the blobs.

Keyword Arguments:

  • hivecatalog_name (str) – Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.

  • hivecatalog_schema (str) – Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.

  • partition_retention_in_days (int) – Retention period for query log table partitions, this doesn’t have any affect on actual data.

  • path (str) – Azure storage location of the blobs.

class azure.mgmt.hdinsightcontainers.models.TrinoUserPlugin(*, enabled: bool | None = None, name: str | None = None, path: str | None = None, **kwargs: Any)[source]

Bases: Model

Trino user plugin.

Variables:

  • enabled (bool) – Denotes whether the plugin is active or not.

  • name (str) – This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.

  • path (str) – Fully qualified path to the folder containing the plugins.

Keyword Arguments:

  • enabled (bool) – Denotes whether the plugin is active or not.

  • name (str) – This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.

  • path (str) – Fully qualified path to the folder containing the plugins.

class azure.mgmt.hdinsightcontainers.models.TrinoUserPlugins(*, plugins: List[_models.TrinoUserPlugin] | None = None, **kwargs: Any)[source]

Bases: Model

Trino user plugins spec.

Variables:

plugins (list[TrinoUserPlugin]) – Trino user plugins.

Keyword Arguments:

plugins (list[TrinoUserPlugin]) – Trino user plugins.

class azure.mgmt.hdinsightcontainers.models.TrinoUserTelemetry(*, storage: _models.TrinoTelemetryConfig | None = None, **kwargs: Any)[source]

Bases: Model

User telemetry.

Variables:

storage (TrinoTelemetryConfig) – Trino user telemetry definition.

Keyword Arguments:

storage (TrinoTelemetryConfig) – Trino user telemetry definition.

class azure.mgmt.hdinsightcontainers.models.TrinoWorker(*, debug: _models.TrinoDebugConfig | None = None, **kwargs: Any)[source]

Bases: Model

Trino worker.

Variables:

debug (TrinoDebugConfig) – Trino debug configuration.

Keyword Arguments:

debug (TrinoDebugConfig) – Trino debug configuration.

class azure.mgmt.hdinsightcontainers.models.Type(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Type of the library.

MAVEN = 'maven'
PYPI = 'pypi'
class azure.mgmt.hdinsightcontainers.models.UpdatableClusterProfile(*, service_configs_profiles: List[_models.ClusterServiceConfigsProfile] | None = None, ssh_profile: _models.SshProfile | None = None, autoscale_profile: _models.AutoscaleProfile | None = None, authorization_profile: _models.AuthorizationProfile | None = None, log_analytics_profile: _models.ClusterLogAnalyticsProfile | None = None, prometheus_profile: _models.ClusterPrometheusProfile | None = None, ranger_plugin_profile: _models.ClusterRangerPluginProfile | None = None, ranger_profile: _models.RangerProfile | None = None, script_action_profiles: List[_models.ScriptActionProfile] | None = None, secrets_profile: _models.SecretsProfile | None = None, trino_profile: _models.TrinoProfile | None = None, **kwargs: Any)[source]

Bases: Model

Cluster resource patch properties.

Variables:
Keyword Arguments:
class azure.mgmt.hdinsightcontainers.models.UpgradeMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.

LAST_STATE_UPDATE = 'LAST_STATE_UPDATE'
STATELESS_UPDATE = 'STATELESS_UPDATE'
UPDATE = 'UPDATE'
class azure.mgmt.hdinsightcontainers.models.WebConnectivityEndpoint(*, fqdn: str, private_fqdn: str | None = None, **kwargs: Any)[source]

Bases: Model

Web connectivity endpoint details.

All required parameters must be populated in order to send to server.

Variables:

  • fqdn (str) – Web connectivity endpoint. Required.

  • private_fqdn (str) – Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.

Keyword Arguments:

  • fqdn (str) – Web connectivity endpoint. Required.

  • private_fqdn (str) – Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.