Subscriptions - List Locations

Reference

Service:: Resource Management

API Version:: 2022-12-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=2022-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/locations?api-version=2022-12-01&includeExtendedLocations={includeExtendedLocations}

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 this operation.
includeExtendedLocations	query		boolean	Whether to include extended locations.

Responses

Name	Type	Description
200 OK	LocationListResult	OK - Returns an array of locations.
Other Status Codes	CloudError	Error response describing why the operation failed.

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

GetLocationsWithASubscriptionId

GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

Sample request

GET https://management.azure.com/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations?api-version=2022-12-01


/**
 * Samples for Subscriptions ListLocations.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
     */
    /**
     * Sample code: GetLocationsWithASubscriptionId.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLocationsWithASubscriptionId(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .listLocations("a1ffc958-d2c7-493e-9f1e-125a0477f536", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_locations.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.list_locations(
        subscription_id="a1ffc958-d2c7-493e-9f1e-125a0477f536",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
func ExampleClient_NewListLocationsPager_getLocationsWithASubscriptionId() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListLocationsPager("a1ffc958-d2c7-493e-9f1e-125a0477f536", &armsubscriptions.ClientListLocationsOptions{IncludeExtendedLocations: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LocationListResult = armsubscriptions.LocationListResult{
		// 	Value: []*armsubscriptions.Location{
		// 		{
		// 			Name: to.Ptr("eastus"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("37.3719"),
		// 				Longitude: to.Ptr("-79.8164"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("westus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US"),
		// 		},
		// 		{
		// 			Name: to.Ptr("eastus2"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus2-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus2-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus2-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US 2"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("36.6681"),
		// 				Longitude: to.Ptr("-78.3889"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("centralus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US 2"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 *
 * @summary This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
 */
async function getLocationsWithASubscriptionId() {
  const subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (let item of client.subscriptions.listLocations(subscriptionId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocations.json
// this example is just showing the usage of "Subscriptions_ListLocations" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscription = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (LocationExpanded item in subscription.GetLocationsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
      "name": "eastus",
      "type": "Region",
      "displayName": "East US",
      "regionalDisplayName": "(US) East US",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-79.8164",
        "latitude": "37.3719",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "westus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
      "name": "eastus2",
      "type": "Region",
      "displayName": "East US 2",
      "regionalDisplayName": "(US) East US 2",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-78.3889",
        "latitude": "36.6681",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "centralus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus2-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus2-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus2-az2"
        }
      ]
    }
  ]
}

GetLocationsWithExtendedLocations

Sample request

GET https://management.azure.com/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations?api-version=2022-12-01&includeExtendedLocations=true


/**
 * Samples for Subscriptions ListLocations.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/
     * GetLocationsWithExtendedLocations.json
     */
    /**
     * Sample code: GetLocationsWithExtendedLocations.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getLocationsWithExtendedLocations(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .listLocations("a1ffc958-d2c7-493e-9f1e-125a0477f536", true, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_locations_with_extended_locations.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.subscriptions.list_locations(
        subscription_id="a1ffc958-d2c7-493e-9f1e-125a0477f536",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
func ExampleClient_NewListLocationsPager_getLocationsWithExtendedLocations() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().NewListLocationsPager("a1ffc958-d2c7-493e-9f1e-125a0477f536", &armsubscriptions.ClientListLocationsOptions{IncludeExtendedLocations: to.Ptr(true)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.LocationListResult = armsubscriptions.LocationListResult{
		// 	Value: []*armsubscriptions.Location{
		// 		{
		// 			Name: to.Ptr("eastus"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("37.3719"),
		// 				Longitude: to.Ptr("-79.8164"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("westus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US"),
		// 		},
		// 		{
		// 			Name: to.Ptr("eastus2"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeRegion),
		// 			AvailabilityZoneMappings: []*armsubscriptions.AvailabilityZoneMappings{
		// 				{
		// 					LogicalZone: to.Ptr("1"),
		// 					PhysicalZone: to.Ptr("eastus2-az1"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("2"),
		// 					PhysicalZone: to.Ptr("eastus2-az3"),
		// 				},
		// 				{
		// 					LogicalZone: to.Ptr("3"),
		// 					PhysicalZone: to.Ptr("eastus2-az2"),
		// 			}},
		// 			DisplayName: to.Ptr("East US 2"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("36.6681"),
		// 				Longitude: to.Ptr("-78.3889"),
		// 				PairedRegion: []*armsubscriptions.PairedRegion{
		// 					{
		// 						Name: to.Ptr("centralus"),
		// 						ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"),
		// 				}},
		// 				PhysicalLocation: to.Ptr("Virginia"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryRecommended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) East US 2"),
		// 		},
		// 		{
		// 			Name: to.Ptr("ezecustomerlabboston1"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeEdgeZone),
		// 			DisplayName: to.Ptr("EZE Customer Lab Boston 1"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("42.301218"),
		// 				Longitude: to.Ptr("-71.219038"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryExtended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) EZE Customer Lab Boston 1"),
		// 		},
		// 		{
		// 			Name: to.Ptr("ezecustomerlabhouston1"),
		// 			Type: to.Ptr(armsubscriptions.LocationTypeEdgeZone),
		// 			DisplayName: to.Ptr("EZE Customer Lab Houston 1"),
		// 			ID: to.Ptr("/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1"),
		// 			Metadata: &armsubscriptions.LocationMetadata{
		// 				Geography: to.Ptr("United States"),
		// 				GeographyGroup: to.Ptr("US"),
		// 				Latitude: to.Ptr("29.9411"),
		// 				Longitude: to.Ptr("-95.41452"),
		// 				RegionCategory: to.Ptr(armsubscriptions.RegionCategoryExtended),
		// 				RegionType: to.Ptr(armsubscriptions.RegionTypePhysical),
		// 			},
		// 			RegionalDisplayName: to.Ptr("(US) EZE Customer Lab Houston 1"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SubscriptionClient } = require("@azure/arm-resources-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 *
 * @summary This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
 */
async function getLocationsWithExtendedLocations() {
  const subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
  const includeExtendedLocations = true;
  const options = {
    includeExtendedLocations,
  };
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (let item of client.subscriptions.listLocations(subscriptionId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetLocationsWithExtendedLocations.json
// this example is just showing the usage of "Subscriptions_ListLocations" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "a1ffc958-d2c7-493e-9f1e-125a0477f536";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscription = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
bool? includeExtendedLocations = true;
await foreach (LocationExpanded item in subscription.GetLocationsAsync(includeExtendedLocations: includeExtendedLocations))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus",
      "name": "eastus",
      "type": "Region",
      "displayName": "East US",
      "regionalDisplayName": "(US) East US",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-79.8164",
        "latitude": "37.3719",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "westus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/westus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus2",
      "name": "eastus2",
      "type": "Region",
      "displayName": "East US 2",
      "regionalDisplayName": "(US) East US 2",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Recommended",
        "geography": "United States",
        "geographyGroup": "US",
        "longitude": "-78.3889",
        "latitude": "36.6681",
        "physicalLocation": "Virginia",
        "pairedRegion": [
          {
            "name": "centralus",
            "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/centralus"
          }
        ]
      },
      "availabilityZoneMappings": [
        {
          "logicalZone": "1",
          "physicalZone": "eastus2-az1"
        },
        {
          "logicalZone": "2",
          "physicalZone": "eastus2-az3"
        },
        {
          "logicalZone": "3",
          "physicalZone": "eastus2-az2"
        }
      ]
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/eastus/edgeZones/ezecustomerlabboston1",
      "name": "ezecustomerlabboston1",
      "type": "EdgeZone",
      "displayName": "EZE Customer Lab Boston 1",
      "regionalDisplayName": "(US) EZE Customer Lab Boston 1",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Extended",
        "geographyGroup": "US",
        "geography": "United States",
        "longitude": "-71.219038",
        "latitude": "42.301218"
      }
    },
    {
      "id": "/subscriptions/a1ffc958-d2c7-493e-9f1e-125a0477f536/locations/southcentralus/edgeZones/ezecustomerlabhouston1",
      "name": "ezecustomerlabhouston1",
      "type": "EdgeZone",
      "displayName": "EZE Customer Lab Houston 1",
      "regionalDisplayName": "(US) EZE Customer Lab Houston 1",
      "metadata": {
        "regionType": "Physical",
        "regionCategory": "Extended",
        "geographyGroup": "US",
        "geography": "United States",
        "longitude": "-95.41452",
        "latitude": "29.9411"
      }
    }
  ]
}

Definitions

Name	Description
AvailabilityZoneMappings	Availability zone mappings for the region
CloudError	An error response for a resource management request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Location	Location information.
LocationListResult	Location list operation response.
LocationMetadata	Location metadata information
LocationType	The location type.
PairedRegion	Information regarding paired region.
RegionCategory	The category of the region.
RegionType	The type of the region.

AvailabilityZoneMappings

Availability zone mappings for the region

Name	Type	Description
logicalZone	string	The logical zone id for the availability zone
physicalZone	string	The fully qualified physical zone id of availability zone to which logical zone id is mapped to

CloudError

An error response for a resource management request.

Name	Type	Description
error	ErrorResponse	Error response Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Location

Location information.

Name	Type	Description
availabilityZoneMappings	AvailabilityZoneMappings[]	The availability zone mappings for this region.
displayName	string	The display name of the location.
id	string	The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/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.
type	LocationType	The location type.

LocationListResult

Location list operation response.

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

LocationMetadata

Location metadata information

Name	Type	Description
geography	string	The geography of the location.
geographyGroup	string	The geography group of the location.
homeLocation	string	The home location of an edge zone.
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.

LocationType

The location type.

Name	Type	Description
EdgeZone	string
Region	string

PairedRegion

Information regarding paired region.

Name	Type	Description
id	string	The fully qualified ID of the location. For example, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
name	string	The name of the paired region.
subscriptionId	string	The subscription ID.

RegionCategory

The category of the region.

Name	Type	Description
Extended	string
Other	string
Recommended	string

RegionType

The type of the region.

Name	Type	Description
Logical	string
Physical	string

Share via

Subscriptions - List Locations

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

GetLocationsWithASubscriptionId

Sample request

Sample response

GetLocationsWithExtendedLocations

Sample request

Sample response

Definitions

AvailabilityZoneMappings

CloudError

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Location

LocationListResult

LocationMetadata

LocationType

PairedRegion

RegionCategory

RegionType

Additional resources