List Locations

  • Article

 

The List Locations operation lists all of the data center locations that are valid for the specified subscription.

Request

The List Locations request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/locations

URI Parameters

None.

Request Headers

The following table describes the request headers.

Request Header

Description

x-ms-version

Required. Specifies the version of the operation to use for this request. This header should be set to 2010-10-28 or higher.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 200 (OK).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

<?xml version="1.0" encoding="utf-8"?>
<Locations xmlns=”https://schemas.microsoft.com/windowsazure”>
  <Location>
    <Name>location-name</Name>
    <DisplayName>localized-location-name</DisplayName>
    <AvailableServices>
         <AvailableService>service-available-to-subscription</AvailableService>
    </AvailableServices>
    <ComputeCapabilities>
      <VirtualMachineRoleSizes>
        <RoleSize>role-size-name</RoleSize>
      </VirtualMachineRoleSizes>
      <WebWorkerRoleSizes>
        <RoleSize>role-size-name</RoleSize>
      </WebWorkerRoleSizes>
    </ComputeCapabilities>
  </Location>
</Locations>

The following table describes the elements of the response body.

Element name

Description

Name

Specifies the name of a data center location that is valid for your subscription.

DisplayName

Specifices the localized name of the data center location.

AvailableService

Specifies the services that are available at the data center location.

Possible values are:

  • Compute

  • Storage

  • PersistentVMRole

  • HighMemory

The AvailableService element is only available using version 2011-12-01 or higher.

ComputeCapabilities

Specifies the roles sizes that are available for deployments in the location. Deployments of web roles and worker roles may have different sizes available than deployments of Virtual Machines.

The ComputeCapabilities element is only available using version 2014-05-01 or higher.

ComputeCapabilities

Specifies the roles sizes that are available for deployments in the location.

Element name

Description

VirtualMachineRoleSizes

Contains a collection of RoleSize elements.

WebWorkerRoleSizes

Contains a collection of RoleSize elements.

RoleSize

Specifies the role size that is available for the type of deployment.