Subscriptions - List Locations

Služba:: Resource Management

Verze rozhraní API:: 2022-12-01

Získá všechna dostupná geografická umístění.
Tato operace poskytuje všechna umístění, která jsou k dispozici pro poskytovatele prostředků; Každý poskytovatel prostředků však může podporovat podmnožinu tohoto seznamu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
includeExtendedLocations	query		boolean	Zda zahrnout rozšířená umístění.

Odpovědi

Name	Typ	Description
200 OK	LocationListResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GetLocationsWithASubscriptionId

GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# 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/subscriptions/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

Ukázková odpověď

Stavový kód:: 200

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

GetLocationsWithExtendedLocations

Ukázkový požadavek

HTTP
Python

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# 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/subscriptions/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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
AvailabilityZoneMappings	Mapování zón dostupnosti pro oblast
CloudError	Odpověď na chybu žádosti o správu prostředků.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Location	Informace o poloze.
LocationListResult	Odpověď operace seznamu umístění.
LocationMetadata	Informace o metadatech umístění
LocationType	Typ umístění.
PairedRegion	Informace týkající se spárované oblasti
RegionCategory	Kategorie oblasti.
RegionType	Typ oblasti.

AvailabilityZoneMappings

Objekt

Mapování zón dostupnosti pro oblast

Name	Typ	Description
logicalZone	string	ID logické zóny pro zónu dostupnosti
physicalZone	string	Plně kvalifikované ID fyzické zóny zóny dostupnosti, na kterou se mapuje ID logické zóny

CloudError

Objekt

Odpověď na chybu žádosti o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Chybová odpověď Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Location

Objekt

Informace o poloze.

Name	Typ	Description
availabilityZoneMappings	AvailabilityZoneMappings[]	Mapování zón dostupnosti pro tuto oblast.
displayName	string	Zobrazovaný název umístění.
id	string	Plně kvalifikované ID umístění. Například /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
metadata	LocationMetadata	Metadata umístění, jako je lat/long, spárovaná oblast a další.
name	string	Název umístění.
regionalDisplayName	string	Zobrazovaný název umístění a jeho oblasti.
subscriptionId	string	ID předplatného.
type	LocationType	Typ umístění.

LocationListResult

Objekt

Odpověď operace seznamu umístění.

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady výsledků.
value	Location[]	Pole umístění.

LocationMetadata

Objekt

Informace o metadatech umístění

Name	Typ	Description
geography	string	Zeměpisná poloha.
geographyGroup	string	Zeměpisná skupina umístění.
homeLocation	string	Domovská poloha hraniční zóny.
latitude	string	Zeměpisná šířka umístění.
longitude	string	Zeměpisná délka umístění.
pairedRegion	PairedRegion[]	Oblasti spárované s touto oblastí.
physicalLocation	string	Fyzické umístění umístění Azure.
regionCategory	RegionCategory	Kategorie oblasti.
regionType	RegionType	Typ oblasti.

LocationType

Výčet

Typ umístění.

Hodnota	Description
Region	Oblast
EdgeZone	EdgeZone

PairedRegion

Objekt

Informace týkající se spárované oblasti

Name	Typ	Description
id	string	Plně kvalifikované ID umístění. Například /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
name	string	Název spárované oblasti.
subscriptionId	string	ID předplatného.

RegionCategory

Výčet

Kategorie oblasti.

Hodnota	Description
Recommended	Doporučený
Extended	Rozšířený
Other	Ostatní

RegionType

Výčet

Typ oblasti.

Hodnota	Description
Physical	Fyzické
Logical	Logical