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

OK. The request has succeeded.

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	select	subscriptionId, resourceGroupName, clusterName, extensionName		Gets the extension properties for the specified HDInsight cluster extension.
create	insert	subscriptionId, resourceGroupName, clusterName, extensionName		Creates an HDInsight cluster extension.
delete	delete	subscriptionId, resourceGroupName, clusterName, extensionName		Deletes the specified extension for HDInsight cluster.
enable_monitoring	exec	subscriptionId, resourceGroupName, clusterName		Enables the Operations Management Suite (OMS) on the HDInsight cluster.
disable_monitoring	exec	subscriptionId, resourceGroupName, clusterName		Disables the Operations Management Suite (OMS) on the HDInsight cluster.
enable_azure_monitor	exec	subscriptionId, resourceGroupName, clusterName		Enables the Azure Monitor on the HDInsight cluster.
disable_azure_monitor	exec	subscriptionId, resourceGroupName, clusterName		Disables the Azure Monitor on the HDInsight cluster.
enable_azure_monitor_agent	exec	subscriptionId, resourceGroupName, clusterName		Enables the Azure Monitor Agent on the HDInsight cluster.
disable_azure_monitor_agent	exec	subscriptionId, resourceGroupName, clusterName		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
clusterName	string	The name of the cluster.
extensionName	string	The name of the cluster extension.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the extension properties for the specified HDInsight cluster extension.

SELECT
clusterMonitoringEnabled,
workspaceId
FROM azure.hdinsight.extensions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND extensionName = '{{ extensionName }}' -- required
;

INSERT examples

create

Creates an HDInsight cluster extension.

INSERT INTO azure.hdinsight.extensions (
data__workspaceId,
data__primaryKey,
subscriptionId,
resourceGroupName,
clusterName,
extensionName
)
SELECT 
'{{ workspaceId }}',
'{{ primaryKey }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ extensionName }}'
;

Manifest

# Description fields are for documentation purposes
- name: extensions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the extensions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the extensions resource.
    - name: clusterName
      value: string
      description: Required parameter for the extensions resource.
    - name: extensionName
      value: string
      description: Required parameter for the extensions resource.
    - name: workspaceId
      value: string
      description: |
        The workspace ID for the cluster monitoring extension.
    - name: primaryKey
      value: string
      description: |
        The certificate for the cluster monitoring extensions.

DELETE examples

delete

Deletes the specified extension for HDInsight cluster.

DELETE FROM azure.hdinsight.extensions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND extensionName = '{{ extensionName }}' --required
;

Lifecycle Methods

enable_monitoring

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

EXEC azure.hdinsight.extensions.enable_monitoring 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required 
@@json=
'{
"workspaceId": "{{ workspaceId }}", 
"primaryKey": "{{ primaryKey }}"
}'
;

disable_monitoring

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

EXEC azure.hdinsight.extensions.disable_monitoring 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required
;

enable_azure_monitor

Enables the Azure Monitor on the HDInsight cluster.

EXEC azure.hdinsight.extensions.enable_azure_monitor 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required
;

enable_azure_monitor_agent

Enables the Azure Monitor Agent on the HDInsight cluster.

EXEC azure.hdinsight.extensions.enable_azure_monitor_agent 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required
;