azure.mgmt.hdinsightcontainers.operations module¶
- class azure.mgmt.hdinsightcontainers.operations.AvailableClusterPoolVersionsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’savailable_cluster_pool_versionsattribute.- list_by_location(location: str, **kwargs: Any) Iterable[ClusterPoolVersion][source]¶
Returns a list of available cluster pool versions.
- Parameters:
location (str) – The name of the Azure region. Required.
- Returns:
An iterator like instance of either ClusterPoolVersion or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.AvailableClusterVersionsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’savailable_cluster_versionsattribute.- list_by_location(location: str, **kwargs: Any) Iterable[ClusterVersion][source]¶
Returns a list of available cluster versions.
- Parameters:
location (str) – The name of the Azure region. Required.
- Returns:
An iterator like instance of either ClusterVersion or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterAvailableUpgradesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_available_upgradesattribute.- list(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) Iterable[ClusterAvailableUpgrade][source]¶
List a cluster available upgrade.
- Parameters:
- Returns:
An iterator like instance of either ClusterAvailableUpgrade or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterJobsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_jobsattribute.- begin_run_job(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_job: _models.ClusterJob, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterJob][source]¶
- begin_run_job(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_job: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterJob]
Operations on jobs of HDInsight on AKS cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
cluster_job (ClusterJob or IO[bytes]) – The Cluster job. Is either a ClusterJob type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either ClusterJob or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, cluster_pool_name: str, cluster_name: str, filter: str | None = None, **kwargs: Any) Iterable[ClusterJob][source]¶
Get jobs of HDInsight on AKS cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
filter (str) – The system query option to filter job returned in the response. Allowed value is ‘jobName eq {jobName}’ or ‘jarName eq {jarName}’. Default value is None.
- Returns:
An iterator like instance of either ClusterJob or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterLibrariesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_librariesattribute.- begin_manage_libraries(resource_group_name: str, cluster_pool_name: str, cluster_name: str, operation: _models.ClusterLibraryManagementOperation, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[None][source]¶
- begin_manage_libraries(resource_group_name: str, cluster_pool_name: str, cluster_name: str, operation: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[None]
Library management operations on HDInsight on AKS cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
operation (ClusterLibraryManagementOperation or IO[bytes]) – The library management operation. Is either a ClusterLibraryManagementOperation type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either None or the result of cls(response)
- Return type:
LROPoller[None]
- Raises:
- list(resource_group_name: str, cluster_pool_name: str, cluster_name: str, category: str | Category, **kwargs: Any) Iterable[ClusterLibrary][source]¶
Get all libraries of HDInsight on AKS cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
category (str or Category) – The system query option to filter libraries returned in the response. Allowed value is ‘custom’ or ‘predefined’. Known values are: “custom” and “predefined”. Required.
- Returns:
An iterator like instance of either ClusterLibrary or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterPoolAvailableUpgradesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_pool_available_upgradesattribute.- list(resource_group_name: str, cluster_pool_name: str, **kwargs: Any) Iterable[ClusterPoolAvailableUpgrade][source]¶
List a cluster pool available upgrade.
- Parameters:
- Returns:
An iterator like instance of either ClusterPoolAvailableUpgrade or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterPoolUpgradeHistoriesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_pool_upgrade_historiesattribute.- list(resource_group_name: str, cluster_pool_name: str, **kwargs: Any) Iterable[ClusterPoolUpgradeHistory][source]¶
Returns a list of upgrade history.
- Parameters:
- Returns:
An iterator like instance of either ClusterPoolUpgradeHistory or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterPoolsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_poolsattribute.- begin_create_or_update(resource_group_name: str, cluster_pool_name: str, cluster_pool: _models.ClusterPool, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool][source]¶
- begin_create_or_update(resource_group_name: str, cluster_pool_name: str, cluster_pool: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool]
Creates or updates a cluster pool.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_pool (ClusterPool or IO[bytes]) – The Cluster Pool to create. Is either a ClusterPool type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either ClusterPool or the result of cls(response)
- Return type:
- Raises:
- begin_delete(resource_group_name: str, cluster_pool_name: str, **kwargs: Any) LROPoller[None][source]¶
Deletes a Cluster Pool.
- Parameters:
- Returns:
An instance of LROPoller that returns either None or the result of cls(response)
- Return type:
LROPoller[None]
- Raises:
- begin_update_tags(resource_group_name: str, cluster_pool_name: str, cluster_pool_tags: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool][source]¶
- begin_update_tags(resource_group_name: str, cluster_pool_name: str, cluster_pool_tags: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool]
Updates an existing Cluster Pool Tags.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_pool_tags (TagsObject or IO[bytes]) – Parameters supplied to update tags. Is either a TagsObject type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either ClusterPool or the result of cls(response)
- Return type:
- Raises:
- begin_upgrade(resource_group_name: str, cluster_pool_name: str, cluster_pool_upgrade_request: _models.ClusterPoolUpgrade, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool][source]¶
- begin_upgrade(resource_group_name: str, cluster_pool_name: str, cluster_pool_upgrade_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.ClusterPool]
Upgrade a cluster pool.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_pool_upgrade_request (ClusterPoolUpgrade or IO[bytes]) – Upgrade a cluster pool. Is either a ClusterPoolUpgrade type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either ClusterPool or the result of cls(response)
- Return type:
- Raises:
- get(resource_group_name: str, cluster_pool_name: str, **kwargs: Any) ClusterPool[source]¶
Gets a cluster pool.
- Parameters:
- Returns:
ClusterPool or the result of cls(response)
- Return type:
- Raises:
- list_by_resource_group(resource_group_name: str, **kwargs: Any) Iterable[ClusterPool][source]¶
Lists the HDInsight cluster pools under a resource group.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
- Returns:
An iterator like instance of either ClusterPool or the result of cls(response)
- Return type:
- Raises:
- list_by_subscription(**kwargs: Any) Iterable[ClusterPool][source]¶
Gets the list of Cluster Pools within a Subscription.
- Returns:
An iterator like instance of either ClusterPool or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClusterUpgradeHistoriesOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’scluster_upgrade_historiesattribute.- list(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) Iterable[ClusterUpgradeHistory][source]¶
Returns a list of upgrade history.
- Parameters:
- Returns:
An iterator like instance of either ClusterUpgradeHistory or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.ClustersOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’sclustersattribute.- begin_create(resource_group_name: str, cluster_pool_name: str, cluster_name: str, hd_insight_cluster: _models.Cluster, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster][source]¶
- begin_create(resource_group_name: str, cluster_pool_name: str, cluster_name: str, hd_insight_cluster: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster]
Creates a cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
hd_insight_cluster (Cluster or IO[bytes]) – The cluster to create. Is either a Cluster type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type:
- Raises:
- begin_delete(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) LROPoller[None][source]¶
Deletes a cluster.
- Parameters:
- Returns:
An instance of LROPoller that returns either None or the result of cls(response)
- Return type:
LROPoller[None]
- Raises:
- begin_resize(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_resize_request: _models.ClusterResizeData, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster][source]¶
- begin_resize(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_resize_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster]
Resize an existing Cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
cluster_resize_request (ClusterResizeData or IO[bytes]) – Resize a cluster. Is either a ClusterResizeData type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type:
- Raises:
- begin_update(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_patch_request: _models.ClusterPatch, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster][source]¶
- begin_update(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_patch_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster]
Updates an existing Cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
cluster_patch_request (ClusterPatch or IO[bytes]) – Patch a cluster. Is either a ClusterPatch type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type:
- Raises:
- begin_upgrade(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_upgrade_request: _models.ClusterUpgrade, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster][source]¶
- begin_upgrade(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_upgrade_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster]
Upgrade a cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
cluster_upgrade_request (ClusterUpgrade or IO[bytes]) – Upgrade a cluster. Is either a ClusterUpgrade type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type:
- Raises:
- begin_upgrade_manual_rollback(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_rollback_upgrade_request: _models.ClusterUpgradeRollback, *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster][source]¶
- begin_upgrade_manual_rollback(resource_group_name: str, cluster_pool_name: str, cluster_name: str, cluster_rollback_upgrade_request: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) LROPoller[_models.Cluster]
Manual rollback upgrade for a cluster.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_pool_name (str) – The name of the cluster pool. Required.
cluster_name (str) – The name of the HDInsight cluster. Required.
cluster_rollback_upgrade_request (ClusterUpgradeRollback or IO[bytes]) – Manual rollback upgrade for a cluster. Is either a ClusterUpgradeRollback type or a IO[bytes] type. Required.
- Returns:
An instance of LROPoller that returns either Cluster or the result of cls(response)
- Return type:
- Raises:
- get(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) Cluster[source]¶
Gets a HDInsight cluster.
- Parameters:
- Returns:
Cluster or the result of cls(response)
- Return type:
- Raises:
- get_instance_view(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) ClusterInstanceViewResult[source]¶
Gets the status of a cluster instance.
- Parameters:
- Returns:
ClusterInstanceViewResult or the result of cls(response)
- Return type:
- Raises:
- list_by_cluster_pool_name(resource_group_name: str, cluster_pool_name: str, **kwargs: Any) Iterable[Cluster][source]¶
Lists the HDInsight cluster pools under a resource group.
- Parameters:
- Returns:
An iterator like instance of either Cluster or the result of cls(response)
- Return type:
- Raises:
- list_instance_views(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) Iterable[ClusterInstanceViewResult][source]¶
Lists the lists of instance views.
- Parameters:
- Returns:
An iterator like instance of either ClusterInstanceViewResult or the result of cls(response)
- Return type:
- Raises:
- list_service_configs(resource_group_name: str, cluster_pool_name: str, cluster_name: str, **kwargs: Any) Iterable[ServiceConfigResult][source]¶
Lists the config dump of all services running in cluster.
- Parameters:
- Returns:
An iterator like instance of either ServiceConfigResult or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.LocationsOperations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’slocationsattribute.- check_name_availability(location: str, name_availability_parameters: _models.NameAvailabilityParameters, *, content_type: str = 'application/json', **kwargs: Any) _models.NameAvailabilityResult[source]¶
- check_name_availability(location: str, name_availability_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) _models.NameAvailabilityResult
Check the availability of the resource name.
- Parameters:
location (str) – The name of the Azure region. Required.
name_availability_parameters (NameAvailabilityParameters or IO[bytes]) – The name and type of the resource. Is either a NameAvailabilityParameters type or a IO[bytes] type. Required.
- Returns:
NameAvailabilityResult or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶
- class azure.mgmt.hdinsightcontainers.operations.Operations(*args, **kwargs)[source]¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
HDInsightContainersMgmtClient’soperationsattribute.- list(**kwargs: Any) Iterable[Operation][source]¶
Returns list of operations.
- Returns:
An iterator like instance of either Operation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.hdinsightcontainers.models' from '/mnt/vss/_work/1/s/sdk/hdinsight/azure-mgmt-hdinsightcontainers/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/hdinsightcontainers/models/__init__.py'>¶