Subscriptions - List Locations

Reference

Service:: Resource Management

API Version:: 2020-01-01

Gets all available geo-locations.
This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

GET https://management.azure.com/subscriptions/{subscriptionId}/locations?api-version=2020-01-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for the operation.

Responses

Name	Type	Description
200 OK	LocationListResult	OK - Returns an array of locations.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get locations with a subscription id

Sample Request

GET https://management.azure.com/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations?api-version=2020-01-01

Sample Response

Status code:: 200

[
  {
    "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/centralus",
    "name": "centralus",
    "displayName": "Central US",
    "regionalDisplayName": "(US) Central US",
    "metadata": {
      "regionType": "Physical",
      "regionCategory": "Recommended",
      "geographyGroup": "US",
      "longitude": "-93.6208",
      "latitude": "41.5908",
      "physicalLocation": "Iowa",
      "pairedRegion": [
        {
          "name": "eastus2",
          "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastus2"
        }
      ]
    }
  },
  {
    "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/eastasia",
    "name": "eastasia",
    "displayName": "East Asia",
    "regionalDisplayName": "(Asia Pacific) East Asia",
    "metadata": {
      "regionType": "Physical",
      "regionCategory": "Recommended",
      "geographyGroup": "Asia Pacific",
      "longitude": "114.188",
      "latitude": "22.267",
      "physicalLocation": "Hong Kong",
      "pairedRegion": [
        {
          "name": "southeastasia",
          "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05/locations/southeastasia"
        }
      ]
    }
  }
]

Definitions

Location	Location information.
LocationListResult	Location list operation response.
LocationMetadata	Location metadata information
PairedRegion	Information regarding paired region.
RegionCategory	The category of the region.
RegionType	The type of the region.

Location

Location information.

Name	Type	Description
displayName	string	The display name of the location.
id	string	The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.
metadata	LocationMetadata	Metadata of the location, such as lat/long, paired region, and others.
name	string	The location name.
regionalDisplayName	string	The display name of the location and its region.
subscriptionId	string	The subscription ID.

LocationListResult

Location list operation response.

Name	Type	Description
value	Location[]	An array of locations.

LocationMetadata

Location metadata information

Name	Type	Description
geographyGroup	string	The geography group of the location.
latitude	string	The latitude of the location.
longitude	string	The longitude of the location.
pairedRegion	PairedRegion[]	The regions paired to this region.
physicalLocation	string	The physical location of the Azure location.
regionCategory	RegionCategory	The category of the region.
regionType	RegionType	The type of the region.

PairedRegion

Information regarding paired region.

Name	Type	Description
id	string	The fully qualified ID of the location. For example, /subscriptions/00000000-0000-0000-0000-000000000000/locations/westus.
name	string	The name of the paired region.
subscriptionId	string	The subscription ID.

RegionCategory

The category of the region.

Name	Type	Description
Other	string
Recommended	string

RegionType

The type of the region.

Name	Type	Description
Logical	string
Physical	string