extensions

Creates, updates, deletes, gets or lists an extensions resource.

Overview

Name	extensions
Type	Resource
Id	azure.hdinsight.extensions

Fields

The following fields are returned by SELECT queries:

get_azure_async_operation_status

Name	Datatype	Description
error	object	The error message associated with the cluster creation.
status	string	The async operation state. Known values are: "InProgress", "Succeeded", and "Failed". (InProgress, Succeeded, Failed)

get

Name	Datatype	Description
clusterMonitoringEnabled	boolean	The status of the monitor on the HDInsight cluster.
workspaceId	string	The workspace ID of the monitor on the HDInsight cluster.

get_monitoring_status

Name	Datatype	Description
clusterMonitoringEnabled	boolean	The status of the monitor on the HDInsight cluster.
workspaceId	string	The workspace ID of the monitor on the HDInsight cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_azure_async_operation_status	select	resource_group_name, cluster_name, extension_name, operation_id, subscription_id		Gets the async operation status.
get	select	resource_group_name, cluster_name, extension_name, subscription_id		Gets the extension properties for the specified HDInsight cluster extension.
get_monitoring_status	select	resource_group_name, cluster_name, subscription_id		Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.
create	insert	resource_group_name, cluster_name, extension_name, subscription_id		Creates an HDInsight cluster extension.
delete	delete	resource_group_name, cluster_name, extension_name, subscription_id		Deletes the specified extension for HDInsight cluster.
disable_monitoring	delete	resource_group_name, cluster_name, subscription_id		Disables the Operations Management Suite (OMS) on the HDInsight cluster.
enable_monitoring	exec	resource_group_name, cluster_name, subscription_id		Enables the Operations Management Suite (OMS) on the HDInsight cluster.
get_azure_monitor_status	exec	resource_group_name, cluster_name, subscription_id		Gets the status of Azure Monitor on the HDInsight cluster.
enable_azure_monitor	exec	resource_group_name, cluster_name, subscription_id		Enables the Azure Monitor on the HDInsight cluster.
disable_azure_monitor	exec	resource_group_name, cluster_name, subscription_id		Disables the Azure Monitor on the HDInsight cluster.
get_azure_monitor_agent_status	exec	resource_group_name, cluster_name, subscription_id		Gets the status of Azure Monitor Agent on the HDInsight cluster.
enable_azure_monitor_agent	exec	resource_group_name, cluster_name, subscription_id		Enables the Azure Monitor Agent on the HDInsight cluster.
disable_azure_monitor_agent	exec	resource_group_name, cluster_name, subscription_id		Disables the Azure Monitor Agent on the HDInsight cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the cluster. Required.
extension_name	string	The name of the cluster extension. Required.
operation_id	string	The long running operation id. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_azure_async_operation_status

Gets the async operation status.

SELECT
error,
status
FROM azure.hdinsight.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the extension properties for the specified HDInsight cluster extension.

SELECT
clusterMonitoringEnabled,
workspaceId
FROM azure.hdinsight.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND extension_name = '{{ extension_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_monitoring_status

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

SELECT
clusterMonitoringEnabled,
workspaceId
FROM azure.hdinsight.extensions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates an HDInsight cluster extension.

INSERT INTO azure.hdinsight.extensions (
workspaceId,
primaryKey,
resource_group_name,
cluster_name,
extension_name,
subscription_id
)
SELECT 
'{{ workspaceId }}',
'{{ primaryKey }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ extension_name }}',
'{{ subscription_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: extensions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the extensions resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the extensions resource.
  - name: extension_name
    value: "{{ extension_name }}"
    description: Required parameter for the extensions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the extensions resource.
  - name: workspaceId
    value: "{{ workspaceId }}"
    description: |
      The workspace ID for the cluster monitoring extension.
  - name: primaryKey
    value: "{{ primaryKey }}"
    description: |
      The certificate for the cluster monitoring extensions.

DELETE examples

delete

Deletes the specified extension for HDInsight cluster.

DELETE FROM azure.hdinsight.extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND extension_name = '{{ extension_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

disable_monitoring

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

DELETE FROM azure.hdinsight.extensions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

enable_monitoring

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

EXEC azure.hdinsight.extensions.enable_monitoring 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"workspaceId": "{{ workspaceId }}", 
"primaryKey": "{{ primaryKey }}"
}'
;

get_azure_monitor_status

Gets the status of Azure Monitor on the HDInsight cluster.

EXEC azure.hdinsight.extensions.get_azure_monitor_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_azure_monitor

Enables the Azure Monitor on the HDInsight cluster.

EXEC azure.hdinsight.extensions.enable_azure_monitor 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"workspaceId": "{{ workspaceId }}", 
"primaryKey": "{{ primaryKey }}", 
"selectedConfigurations": "{{ selectedConfigurations }}"
}'
;

disable_azure_monitor

Disables the Azure Monitor on the HDInsight cluster.

EXEC azure.hdinsight.extensions.disable_azure_monitor 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_azure_monitor_agent_status

Gets the status of Azure Monitor Agent on the HDInsight cluster.

EXEC azure.hdinsight.extensions.get_azure_monitor_agent_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

enable_azure_monitor_agent

Enables the Azure Monitor Agent on the HDInsight cluster.

EXEC azure.hdinsight.extensions.enable_azure_monitor_agent 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"workspaceId": "{{ workspaceId }}", 
"primaryKey": "{{ primaryKey }}", 
"selectedConfigurations": "{{ selectedConfigurations }}"
}'
;

disable_azure_monitor_agent

Disables the Azure Monitor Agent on the HDInsight cluster.

EXEC azure.hdinsight.extensions.disable_azure_monitor_agent 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;