ExtensionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:extensions> attribute.

Constructor

ExtensionsOperations(*args, **kwargs)

Methods

begin_create	Creates an HDInsight cluster extension.
begin_delete	Deletes the specified extension for HDInsight cluster.
begin_disable_azure_monitor	Disables the Azure Monitor on the HDInsight cluster.
begin_disable_monitoring	Disables the Operations Management Suite (OMS) on the HDInsight cluster.
begin_enable_azure_monitor	Enables the Azure Monitor on the HDInsight cluster.
begin_enable_monitoring	Enables the Operations Management Suite (OMS) on the HDInsight cluster.
get	Gets the extension properties for the specified HDInsight cluster extension.
get_azure_async_operation_status	Gets the async operation status.
get_azure_monitor_status	Gets the status of Azure Monitor on the HDInsight cluster.
get_monitoring_status	Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.

begin_create

Creates an HDInsight cluster extension.

begin_create(resource_group_name: str, cluster_name: str, extension_name: str, parameters: _models.Extension, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
extension_name Required	str The name of the cluster extension. Required.
parameters Required	Extension or IO[bytes] The cluster extensions create request. Is either a Extension type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified extension for HDInsight cluster.

begin_delete(resource_group_name: str, cluster_name: str, extension_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
extension_name Required	str The name of the cluster extension. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_disable_azure_monitor

Disables the Azure Monitor on the HDInsight cluster.

begin_disable_azure_monitor(resource_group_name: str, cluster_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_disable_monitoring

Disables the Operations Management Suite (OMS) on the HDInsight cluster.

begin_disable_monitoring(resource_group_name: str, cluster_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_enable_azure_monitor

Enables the Azure Monitor on the HDInsight cluster.

begin_enable_azure_monitor(resource_group_name: str, cluster_name: str, parameters: _models.AzureMonitorRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	AzureMonitorRequest or IO[bytes] The Log Analytics workspace parameters. Is either a AzureMonitorRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_enable_monitoring

Enables the Operations Management Suite (OMS) on the HDInsight cluster.

begin_enable_monitoring(resource_group_name: str, cluster_name: str, parameters: _models.ClusterMonitoringRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
parameters Required	ClusterMonitoringRequest or IO[bytes] The Operations Management Suite (OMS) workspace parameters. Is either a ClusterMonitoringRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the extension properties for the specified HDInsight cluster extension.

get(resource_group_name: str, cluster_name: str, extension_name: str, **kwargs: Any) -> ClusterMonitoringResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
extension_name Required	str The name of the cluster extension. Required.

Returns

Type	Description
ClusterMonitoringResponse	ClusterMonitoringResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_azure_async_operation_status

Gets the async operation status.

get_azure_async_operation_status(resource_group_name: str, cluster_name: str, extension_name: str, operation_id: str, **kwargs: Any) -> AsyncOperationResult

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.
extension_name Required	str The name of the cluster extension. Required.
operation_id Required	str The long running operation id. Required.

Returns

Type	Description
AsyncOperationResult	AsyncOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_azure_monitor_status

Gets the status of Azure Monitor on the HDInsight cluster.

get_azure_monitor_status(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AzureMonitorResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
AzureMonitorResponse	AzureMonitorResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_monitoring_status

Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.

get_monitoring_status(resource_group_name: str, cluster_name: str, **kwargs: Any) -> ClusterMonitoringResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cluster_name Required	str The name of the cluster. Required.

Returns

Type	Description
ClusterMonitoringResponse	ClusterMonitoringResponse or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.hdinsight.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv145\\Lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>

Feedback

Was this page helpful?