Subscriptions - List Locations

Obtém todas as localizações geográficas disponíveis.
Essa operação fornece todos os locais disponíveis para provedores de recursos; no entanto, cada provedor de recursos pode dar suporte a um subconjunto dessa lista.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

includeExtendedLocations
query

boolean

Se os locais estendidos devem ser incluídos.

Respostas

Nome Tipo Description
200 OK

LocationListResult

OK – retorna uma matriz de locais.

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

GetLocationsWithASubscriptionId
GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

Sample Request

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

Sample Response

{
  "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

Sample Response

{
  "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"
      }
    }
  ]
}

Definições

Nome Description
AvailabilityZoneMappings

Mapeamentos de zona de disponibilidade para a região

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

Location

Informações de localização.

LocationListResult

Resposta da operação de lista de localização.

LocationMetadata

Informações de metadados de localização

LocationType

O tipo de local.

PairedRegion

Informações sobre a região emparelhada.

RegionCategory

A categoria da região.

RegionType

O tipo da região.

AvailabilityZoneMappings

Mapeamentos de zona de disponibilidade para a região

Nome Tipo Description
logicalZone

string

A ID da zona lógica para a zona de disponibilidade

physicalZone

string

A ID de zona física totalmente qualificada da zona de disponibilidade para a qual a ID da zona lógica é mapeada para

CloudError

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Nome Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

Location

Informações de localização.

Nome Tipo Description
availabilityZoneMappings

AvailabilityZoneMappings[]

Os mapeamentos de zona de disponibilidade para essa região.

displayName

string

O nome de exibição do local.

id

string

A ID totalmente qualificada do local. Por exemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.

metadata

LocationMetadata

Metadados do local, como lat/long, região emparelhada e outros.

name

string

O nome do local.

regionalDisplayName

string

O nome de exibição do local e sua região.

subscriptionId

string

A ID da assinatura.

type

LocationType

O tipo de local.

LocationListResult

Resposta da operação de lista de localização.

Nome Tipo Description
value

Location[]

Uma matriz de locais.

LocationMetadata

Informações de metadados de localização

Nome Tipo Description
geography

string

A geografia do local.

geographyGroup

string

O grupo de geografia do local.

homeLocation

string

A localização inicial de uma zona de borda.

latitude

string

A latitude da localização.

longitude

string

A longitude da localização.

pairedRegion

PairedRegion[]

As regiões emparelhadas com essa região.

physicalLocation

string

O local físico do local do Azure.

regionCategory

RegionCategory

A categoria da região.

regionType

RegionType

O tipo da região.

LocationType

O tipo de local.

Nome Tipo Description
EdgeZone

string

Region

string

PairedRegion

Informações sobre a região emparelhada.

Nome Tipo Description
id

string

A ID totalmente qualificada do local. Por exemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.

name

string

O nome da região emparelhada.

subscriptionId

string

A ID da assinatura.

RegionCategory

A categoria da região.

Nome Tipo Description
Extended

string

Other

string

Recommended

string

RegionType

O tipo da região.

Nome Tipo Description
Logical

string

Physical

string