configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	configurations
Type	Resource
Id	azure.hdinsight.configurations

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
configurations	object	The configuration object for the specified configuration for the specified cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resource_group_name, cluster_name, subscription_id		Gets all configuration information for an HDI cluster.
get_raw	exec	resource_group_name, cluster_name, configuration_name, subscription_id		The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.
update	exec	resource_group_name, cluster_name, configuration_name, subscription_id		Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

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.
configuration_name	string	The name of the cluster configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list

Gets all configuration information for an HDI cluster.

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

Lifecycle Methods

get_raw

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

EXEC azure.hdinsight.configurations.get_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

EXEC azure.hdinsight.configurations.update 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;