locations

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

Overview

Name	locations
Type	Resource
Id	azure.hdinsight.locations

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)

list_usages

Name	Datatype	Description
name	object	The details about the localizable name of the used resource.
currentValue	integer	The current usage.
limit	integer	The maximum allowed usage.
unit	string	The type of measurement for usage.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_azure_async_operation_status	select	location, operation_id, subscription_id		Get the async operation status.
list_usages	select	location, subscription_id		Lists the usages for the specified location.
list_billing_specs	exec	location, subscription_id		Lists the billingSpecs for the specified subscription and location.
get_capabilities	exec	location, subscription_id		Gets the capabilities for the specified location.
check_name_availability	exec	location, subscription_id		Check the cluster name is available or not.
validate_cluster_create_request	exec	location, subscription_id		Validate the cluster create request spec is valid or not.

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
location	string	The name of the Azure region. Required.
operation_id	string	The long running operation id. Required.
subscription_id	string

SELECT examples

get_azure_async_operation_status

Get the async operation status.

SELECT
error,
status
FROM azure.hdinsight.locations
WHERE location = '{{ location }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_usages

Lists the usages for the specified location.

SELECT
name,
currentValue,
limit,
unit
FROM azure.hdinsight.locations
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_billing_specs

Lists the billingSpecs for the specified subscription and location.

EXEC azure.hdinsight.locations.list_billing_specs 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_capabilities

Gets the capabilities for the specified location.

EXEC azure.hdinsight.locations.get_capabilities 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

check_name_availability

Check the cluster name is available or not.

EXEC azure.hdinsight.locations.check_name_availability 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

validate_cluster_create_request

Validate the cluster create request spec is valid or not.

EXEC azure.hdinsight.locations.validate_cluster_create_request 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"zones": "{{ zones }}", 
"properties": "{{ properties }}", 
"identity": "{{ identity }}", 
"name": "{{ name }}", 
"type": "{{ type }}", 
"tenantId": "{{ tenantId }}", 
"fetchAaddsResource": {{ fetchAaddsResource }}
}'
;