Compartir a través de

Subscriptions - List Locations

Servicio:
Resource Management
Versión de la API:
2022-12-01

Obtiene todas las ubicaciones geográficas disponibles.
Esta operación proporciona todas las ubicaciones disponibles para los proveedores de recursos; sin embargo, cada proveedor de recursos puede admitir un subconjunto de esta lista.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
subscriptionId
 path True

string

Identificador de la suscripción de destino.
api-version
 query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.
includeExtendedLocations
 query

boolean

Indica si se deben incluir ubicaciones extendidas.

Respuestas

Nombre Tipo Description
200 OK

LocationListResult

Aceptar: devuelve una matriz de ubicaciones.
Other Status Codes

CloudError

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

GetLocationsWithASubscriptionId
GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
AvailabilityZoneMappings

Asignaciones de zona de disponibilidad para la región
CloudError

Respuesta de error para una solicitud de administración de recursos.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
Location

Información de ubicación.
LocationListResult

Respuesta de la operación de lista de ubicaciones.
LocationMetadata

Información de metadatos de ubicación
LocationType

Tipo de ubicación.
PairedRegion

Información sobre la región emparejada.
RegionCategory

Categoría de la región.
RegionType

Tipo de la región.

AvailabilityZoneMappings

Objeto

Asignaciones de zona de disponibilidad para la región

Nombre Tipo Description
logicalZone

string

Identificador de zona lógica para la zona de disponibilidad
physicalZone

string

Identificador de zona física completa de la zona de disponibilidad a la que se asigna el identificador de zona lógica a

CloudError

Objeto

Respuesta de error para una solicitud de administración de recursos.

Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

Location

Objeto

Información de ubicación.

Nombre Tipo Description
availabilityZoneMappings

AvailabilityZoneMappings[]

Asignaciones de zona de disponibilidad para esta región.
displayName

string

Nombre para mostrar de la ubicación.
id

string

Identificador completo de la ubicación. Por ejemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
metadata

LocationMetadata

Metadatos de la ubicación, como lat/long, la región emparejada y otras.
name

string

Nombre de ubicación.
regionalDisplayName

string

Nombre para mostrar de la ubicación y su región.
subscriptionId

string

Identificador de suscripción.
type

LocationType

Tipo de ubicación.

LocationListResult

Objeto

Respuesta de la operación de lista de ubicaciones.

Nombre Tipo Description
value

Location[]

Matriz de ubicaciones.

LocationMetadata

Objeto

Información de metadatos de ubicación

Nombre Tipo Description
geography

string

Geografía de la ubicación.
geographyGroup

string

Grupo de geografía de la ubicación.
homeLocation

string

Ubicación principal de una zona perimetral.
latitude

string

Latitud de la ubicación.
longitude

string

Longitud de la ubicación.
pairedRegion

PairedRegion[]

Regiones emparejadas con esta región.
physicalLocation

string

Ubicación física de la ubicación de Azure.
regionCategory

RegionCategory

Categoría de la región.
regionType

RegionType

Tipo de la región.

LocationType

Enumeración

Tipo de ubicación.

Valor Description
Region
EdgeZone

PairedRegion

Objeto

Información sobre la región emparejada.

Nombre Tipo Description
id

string

Identificador completo de la ubicación. Por ejemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
name

string

Nombre de la región emparejada.
subscriptionId

string

Identificador de suscripción.

RegionCategory

Enumeración

Categoría de la región.

Valor Description
Recommended
Extended
Other

RegionType

Enumeración

Tipo de la región.

Valor Description
Physical
Logical