clusters_gateway_settings
Creates, updates, deletes, gets or lists a clusters_gateway_settings resource.
Overview
| Name | clusters_gateway_settings |
| Type | Resource |
| Id | azure.hdinsight.clusters_gateway_settings |
Fields
The following fields are returned by SELECT queries:
- get
OK response definition.
| Name | Datatype | Description |
|---|---|---|
restAuthCredential.isEnabled | string | Indicates whether or not the gateway settings based authorization is enabled. (x-ms-client-name: isCredentialEnabled) |
restAuthCredential.password | string | The gateway settings user password. (x-ms-client-name: password) |
restAuthCredential.username | string | The gateway settings user name. (x-ms-client-name: userName) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, clusterName | Gets the gateway settings for the specified cluster. | |
update | exec | subscriptionId, resourceGroupName, clusterName | Configures the gateway settings on the specified 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. |
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 gateway settings for the specified cluster.
SELECT
restAuthCredential.isEnabled,
restAuthCredential.password,
restAuthCredential.username
FROM azure.hdinsight.clusters_gateway_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;
Lifecycle Methods
- update
Configures the gateway settings on the specified cluster.
EXEC azure.hdinsight.clusters_gateway_settings.update
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@clusterName='{{ clusterName }}' --required
@@json=
'{
"restAuthCredential.isEnabled": {{ restAuthCredential.isEnabled }},
"restAuthCredential.username": "{{ restAuthCredential.username }}",
"restAuthCredential.password": "{{ restAuthCredential.password }}"
}'
;