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:

get

OK response definition.

Name	Datatype	Description

list

OK response definition.

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
get	select	subscriptionId, resourceGroupName, clusterName, configurationName		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.
list	select	subscriptionId, resourceGroupName, clusterName		Gets all configuration information for an HDI cluster.
update	exec	subscriptionId, resourceGroupName, clusterName, configurationName		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
clusterName	string	The name of the cluster.
configurationName	string	The name of the cluster configuration.
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

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.

SELECT
*
FROM azure.hdinsight.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND configurationName = '{{ configurationName }}' -- required
;

list

Gets all configuration information for an HDI cluster.

SELECT
configurations
FROM azure.hdinsight.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

Lifecycle Methods

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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@clusterName='{{ clusterName }}' --required, 
@configurationName='{{ configurationName }}' --required
;