ExtensionsOperations Class

ExtensionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Constructor

ExtensionsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

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', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
cluster_name Required	str The name of the cluster.
extension_name Required	str The name of the cluster extension.
parameters Required	Extension The cluster extensions create request.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
cluster_name Required	str The name of the cluster.
extension_name Required	str The name of the cluster extension.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
cluster_name Required	str The name of the cluster.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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.
cluster_name Required	str The name of the cluster.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
cluster_name Required	str The name of the cluster.
parameters Required	AzureMonitorRequest The Log Analytics workspace parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group.
cluster_name Required	str The name of the cluster.
parameters Required	ClusterMonitoringRequest The Operations Management Suite (OMS) workspace parameters.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

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) -> _models.ClusterMonitoringResponse

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> _models.AsyncOperationResult

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> _models.AzureMonitorResponse

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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) -> _models.ClusterMonitoringResponse

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv131\\Lib\\site-packages\\azure\\mgmt\\hdinsight\\models\\__init__.py'>