locations

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

Overview

Name	locations
Type	Resource
Id	azure.cosmos_db.locations

Fields

The following fields are returned by SELECT queries:

get

The Cosmos DB location properties were retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Cosmos DB location metadata
type	string	The type of Azure resource.

list

The operation completed successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Cosmos DB location metadata
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, location		Get the properties of an existing Cosmos DB location
list	select	subscriptionId		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.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get the properties of an existing Cosmos DB location

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND location = '{{ location }}' -- required
;

list

List Cosmos DB locations and their properties

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;