location

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

Overview

Name	location
Type	Resource
Id	azure.batch.location

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
message	string	Gets an error message explaining the Reason value in more detail.
nameAvailable	boolean	Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
reason	string	Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

list_supported_virtual_machine_skus

Name	Datatype	Description
name	string	The name of the SKU.
batchSupportEndOfLife	string (date-time)	The time when Azure Batch service will retire this SKU.
capabilities	array	A collection of capabilities which this SKU supports.
familyName	string	The family name of the SKU.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_name_availability	select	location_name, subscription_id		Checks whether the Batch account name is available in the specified region.
list_supported_virtual_machine_skus	select	location_name, subscription_id	maxresults, $filter	Gets the list of Batch supported Virtual Machine VM sizes available at the given location.
get_quotas	exec	location_name, subscription_id		Gets the Batch service quotas for the specified subscription at the given location.

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_name	string	The region for which to retrieve Batch service quotas. Required.
subscription_id	string
$filter	string	OData filter expression. Valid properties for filtering are "familyName". Default value is None.
maxresults	integer	The maximum number of items to return in the response. Default value is None.

SELECT examples

check_name_availability

Checks whether the Batch account name is available in the specified region.

SELECT
message,
nameAvailable,
reason
FROM azure.batch.location
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_supported_virtual_machine_skus

Gets the list of Batch supported Virtual Machine VM sizes available at the given location.

SELECT
name,
batchSupportEndOfLife,
capabilities,
familyName
FROM azure.batch.location
WHERE location_name = '{{ location_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND maxresults = '{{ maxresults }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

get_quotas

Gets the Batch service quotas for the specified subscription at the given location.

EXEC azure.batch.location.get_quotas 
@location_name='{{ location_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;