Subscriptions - List Locations

Service:: Resource Management

Version de l’API:: 2022-12-01

Obtient tous les emplacements géographiques disponibles.
Cette opération fournit tous les emplacements disponibles pour les fournisseurs de ressources ; Toutefois, chaque fournisseur de ressources peut prendre en charge un sous-ensemble de cette liste.

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

Avec paramètres optionnels:

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

Paramètres d’URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
includeExtendedLocations	query		boolean	Indique s’il faut inclure des emplacements étendus.

Réponses

Nom	Type	Description
200 OK	LocationListResult	OK : retourne un tableau d’emplacements.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Couler: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GetLocationsWithASubscriptionId

GetLocationsWithExtendedLocations

GetLocationsWithASubscriptionId

Demande d’échantillon

HTTP

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

Exemple de réponse

Code d’état:: 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

Demande d’échantillon

HTTP

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

Exemple de réponse

Code d’état:: 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"
      }
    }
  ]
}

Définitions

Nom	Description
AvailabilityZoneMappings	Mappages de zones de disponibilité pour la région
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
Location	Informations d’emplacement.
LocationListResult	Réponse de l’opération de liste d’emplacements.
LocationMetadata	Informations sur les métadonnées d’emplacement
LocationType	Type d’emplacement.
PairedRegion	Informations relatives à la région jumelée.
RegionCategory	Catégorie de la région.
RegionType	Type de la région.

AvailabilityZoneMappings

Objet

Mappages de zones de disponibilité pour la région

Nom	Type	Description
logicalZone	string	ID de zone logique pour la zone de disponibilité
physicalZone	string	ID de zone physique complet de la zone de disponibilité à laquelle l’ID de zone logique est mappé à

CloudError

Objet

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Location

Objet

Informations d’emplacement.

Nom	Type	Description
availabilityZoneMappings	AvailabilityZoneMappings[]	Mappages de zone de disponibilité pour cette région.
displayName	string	Nom complet de l’emplacement.
id	string	ID complet de l’emplacement. Par exemple, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
metadata	LocationMetadata	Métadonnées de l’emplacement, telles que lat/long, région jumelée et autres.
name	string	Nom de l’emplacement.
regionalDisplayName	string	Nom complet de l’emplacement et de sa région.
subscriptionId	string	ID d’abonnement.
type	LocationType	Type d’emplacement.

LocationListResult

Objet

Réponse de l’opération de liste d’emplacements.

Nom	Type	Description
value	Location[]	Tableau d’emplacements.

LocationMetadata

Objet

Informations sur les métadonnées d’emplacement

Nom	Type	Description
geography	string	Zone géographique de l’emplacement.
geographyGroup	string	Groupe géographique de l’emplacement.
homeLocation	string	Emplacement d’accueil d’une zone de périphérie.
latitude	string	Latitude de l’emplacement.
longitude	string	Longitude de l’emplacement.
pairedRegion	PairedRegion[]	Régions jumelées à cette région.
physicalLocation	string	Emplacement physique de l’emplacement Azure.
regionCategory	RegionCategory	Catégorie de la région.
regionType	RegionType	Type de la région.

LocationType

Énumération

Type d’emplacement.

Valeur	Description
Region
EdgeZone

PairedRegion

Objet

Informations relatives à la région jumelée.

Nom	Type	Description
id	string	ID complet de l’emplacement. Par exemple, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74/locations/westus.
name	string	Nom de la région jumelée.
subscriptionId	string	ID d’abonnement.

RegionCategory

Énumération

Catégorie de la région.

Valeur	Description
Recommended
Extended
Other

RegionType

Énumération

Type de la région.

Valeur	Description
Physical
Logical

Partager via

Subscriptions - List Locations

Paramètres d’URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

GetLocationsWithASubscriptionId

Demande d’échantillon

Exemple de réponse

GetLocationsWithExtendedLocations

Demande d’échantillon

Exemple de réponse

Définitions

AvailabilityZoneMappings

CloudError

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Location

LocationListResult

LocationMetadata

LocationType

PairedRegion

RegionCategory

RegionType