Udostępnij przez

Subscriptions - List Locations

Usługa:
Resource Management
Wersja interfejsu API:
2022-12-01

Pobiera wszystkie dostępne lokalizacje geograficzne.
Ta operacja udostępnia wszystkie lokalizacje, które są dostępne dla dostawców zasobów; jednak każdy dostawca zasobów może obsługiwać podzestaw tej listy.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
includeExtendedLocations
 query

boolean

Czy należy uwzględnić lokalizacje rozszerzone.

Odpowiedzi

Nazwa Typ Opis
200 OK

LocationListResult

OK — zwraca tablicę lokalizacji.
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

GetLocationsWithASubscriptionId
GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

Przykładowe zapytanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe zapytanie

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

Przykładowa odpowiedź

Kod stanu:
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"
      }
    }
  ]
}

Definicje

Nazwa Opis
AvailabilityZoneMappings

Mapowania stref dostępności dla regionu
CloudError

Odpowiedź na błąd żądania zarządzania zasobami.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
Location

Informacje o lokalizacji.
LocationListResult

Odpowiedź operacji listy lokalizacji.
LocationMetadata

Informacje o metadanych lokalizacji
LocationType

Typ lokalizacji.
PairedRegion

Informacje dotyczące sparowanego regionu.
RegionCategory

Kategoria regionu.
RegionType

Typ regionu.

AvailabilityZoneMappings

Sprzeciwiać się

Mapowania stref dostępności dla regionu

Nazwa Typ Opis
logicalZone

string

Identyfikator strefy logicznej strefy dostępności
physicalZone

string

W pełni kwalifikowany identyfikator strefy fizycznej strefy dostępności, do której jest mapowany identyfikator strefy logicznej

CloudError

Sprzeciwiać się

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

Location

Sprzeciwiać się

Informacje o lokalizacji.

Nazwa Typ Opis
availabilityZoneMappings

AvailabilityZoneMappings[]

Mapowania strefy dostępności dla tego regionu.
displayName

string

Nazwa wyświetlana lokalizacji.
id

string

W pełni kwalifikowany identyfikator lokalizacji. Na przykład /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
metadata

LocationMetadata

Metadane lokalizacji, takie jak lat/long, sparowany region i inne.
name

string

Nazwa lokalizacji.
regionalDisplayName

string

Nazwa wyświetlana lokalizacji i jej regionu.
subscriptionId

string

Identyfikator subskrypcji.
type

LocationType

Typ lokalizacji.

LocationListResult

Sprzeciwiać się

Odpowiedź operacji listy lokalizacji.

Nazwa Typ Opis
value

Location[]

Tablica lokalizacji.

LocationMetadata

Sprzeciwiać się

Informacje o metadanych lokalizacji

Nazwa Typ Opis
geography

string

Lokalizacja geograficzna.
geographyGroup

string

Grupa geografii lokalizacji.
homeLocation

string

Lokalizacja domowa strefy krawędzi.
latitude

string

Szerokość geograficzna lokalizacji.
longitude

string

Długość geograficzna lokalizacji.
pairedRegion

PairedRegion[]

Regiony sparowane z tym regionem.
physicalLocation

string

Lokalizacja fizyczna lokalizacji platformy Azure.
regionCategory

RegionCategory

Kategoria regionu.
regionType

RegionType

Typ regionu.

LocationType

Wyliczenie

Typ lokalizacji.

Wartość Opis
Region
EdgeZone

PairedRegion

Sprzeciwiać się

Informacje dotyczące sparowanego regionu.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator lokalizacji. Na przykład /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
name

string

Nazwa sparowanego regionu.
subscriptionId

string

Identyfikator subskrypcji.

RegionCategory

Wyliczenie

Kategoria regionu.

Wartość Opis
Recommended
Extended
Other

RegionType

Wyliczenie

Typ regionu.

Wartość Opis
Physical
Logical