locations

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

Overview

Name	locations
Type	Resource
Id	azure.cosmosdb.locations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupStorageRedundancies	array	The properties of available backup storage redundancies.
isResidencyRestricted	boolean	Flag indicating whether the location is residency sensitive.
isSubscriptionRegionAccessAllowedForAz	boolean	Flag indicating whether the subscription have access in region for Availability Zones(Az).
isSubscriptionRegionAccessAllowedForRegular	boolean	Flag indicating whether the subscription have access in region for Non-Availability Zones.
status	string	Enum to indicate current buildout status of the region. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
supportsAvailabilityZone	boolean	Flag indicating whether the location supports availability zones or not.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
backupStorageRedundancies	array	The properties of available backup storage redundancies.
isResidencyRestricted	boolean	Flag indicating whether the location is residency sensitive.
isSubscriptionRegionAccessAllowedForAz	boolean	Flag indicating whether the subscription have access in region for Availability Zones(Az).
isSubscriptionRegionAccessAllowedForRegular	boolean	Flag indicating whether the subscription have access in region for Non-Availability Zones.
status	string	Enum to indicate current buildout status of the region. Known values are: "Uninitialized", "Initializing", "InternallyReady", "Online", "Deleting", "Succeeded", "Failed", "Canceled", "Updating", and "Creating". (Uninitialized, Initializing, InternallyReady, Online, Deleting, Succeeded, Failed, Canceled, Updating, Creating)
supportsAvailabilityZone	boolean	Flag indicating whether the location supports availability zones or not.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	location, subscription_id		Get the properties of an existing Cosmos DB location.
list	select	subscription_id		List Cosmos DB locations and their properties.

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	Cosmos DB region, with spaces between words and each word capitalized. Required.
subscription_id	string

SELECT examples

get

Get the properties of an existing Cosmos DB location.

SELECT
id,
name,
backupStorageRedundancies,
isResidencyRestricted,
isSubscriptionRegionAccessAllowedForAz,
isSubscriptionRegionAccessAllowedForRegular,
status,
supportsAvailabilityZone,
systemData,
type
FROM azure.cosmosdb.locations
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Cosmos DB locations and their properties.

SELECT
id,
name,
backupStorageRedundancies,
isResidencyRestricted,
isSubscriptionRegionAccessAllowedForAz,
isSubscriptionRegionAccessAllowedForRegular,
status,
supportsAvailabilityZone,
systemData,
type
FROM azure.cosmosdb.locations
WHERE subscription_id = '{{ subscription_id }}' -- required
;