Search - Get Polygon
Permet d’obtenir des données de polygones d’une forme géographique telle qu’une ville ou une région de pays.
L’API Get Polygon est une requête HTTP GET qui fournit des données polygones d’un plan géographique tel qu’une ville ou une région de pays.
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
|
coordinates
|
query | True |
number[] |
Point sur la terre spécifié comme longitude et latitude. Exemple : coordonnées &=lon,lat |
|
resolution
|
query |
La résolution détermine la quantité de points à renvoyer. S’il n’est pas spécifié, la résolution par défaut est moyenne. |
||
|
result
|
query |
Concept géopolitique pour lequel retourner une limite. S’il n’est pas spécifié, la valeur par défaut est |
||
|
view
|
query |
string |
Chaîne qui représente une code ISO 3166-1 Alpha-2 région/pays. Cela modifie les bordures et étiquettes contestées géopolitiques pour s’aligner sur la région utilisateur spécifiée. Par défaut, le paramètre View est défini sur « Auto », même si vous ne l’avez pas défini dans la requête. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Spécifie le compte destiné à l’utilisation conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps. |
|
| Accept-Language |
string |
Langue dans laquelle les résultats de recherche doivent être retournés. Pour plus d’informations, consultez langues prises en charge. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Ok Media Types: "application/geo+json" |
|
| Other Status Codes |
Une erreur inattendue s’est produite. Media Types: "application/geo+json" |
Sécurité
AADToken
Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Remarque
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-idpour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps. - La
Authorization URLest spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. - Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
- L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.
Type:
apiKey
Dans:
header
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.
Type:
apiKey
Dans:
header
Exemples
Get polygon for a city at coordinates -122.204141,47.612560
Exemple de requête
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Exemple de réponse
Content-Type: application/geo+json
{
"type": "Feature",
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.13035,
47.53502
],
[
-122.12882,
47.53567
],
[
-122.12638000000001,
47.535140000000006
],
[
-122.12378000000001,
47.53717
],
[
-122.12068000000001,
47.537620000000004
],
[
-122.12028000000001,
47.538000000000004
],
[
-122.11682,
47.537940000000006
],
[
-122.11527000000001,
47.53609
],
[
-122.11119000000001,
47.536080000000005
],
[
-122.11103000000001,
47.539280000000005
],
[
-122.10832,
47.539530000000006
],
[
-122.10830000000001,
47.54057
],
[
-122.11006,
47.54055
],
[
-122.10999000000001,
47.542640000000006
],
[
-122.11185,
47.54298000000001
],
[
-122.11183000000001,
47.54426
],
[
-122.1114,
47.543800000000005
],
[
-122.10936000000001,
47.54379
],
[
-122.10912,
47.54462
],
[
-122.10745000000001,
47.544830000000005
],
[
-122.10808000000002,
47.545190000000005
],
[
-122.10808000000002,
47.54656000000001
],
[
-122.10665000000002,
47.546580000000006
],
[
-122.10711,
47.544700000000006
],
[
-122.10530000000001,
47.54473
],
[
-122.1054,
47.546910000000004
],
[
-122.10434000000001,
47.54693
],
[
-122.10433,
47.544830000000005
],
[
-122.10056000000002,
47.544940000000004
],
[
-122.1007,
47.548500000000004
],
[
-122.10194000000001,
47.54849
],
[
-122.10194000000001,
47.54883
],
[
-122.10194000000001,
47.549510000000005
],
[
-122.10071,
47.54883
],
[
-122.10048,
47.54849
],
[
-122.10047000000002,
47.54883
],
[
-122.10038000000002,
47.55904
],
[
-122.09796000000001,
47.55923000000001
],
[
-122.09870000000001,
47.560570000000006
],
[
-122.09818000000001,
47.56248
],
[
-122.10011000000002,
47.56839
],
[
-122.09876000000001,
47.56884
],
[
-122.09942000000001,
47.569900000000004
],
[
-122.09782000000001,
47.56983
],
[
-122.09672,
47.58019
],
[
-122.09885000000001,
47.58666
],
[
-122.09796000000001,
47.59503
],
[
-122.09664000000001,
47.602230000000006
],
[
-122.09411000000001,
47.607240000000004
],
[
-122.09104,
47.610240000000005
],
[
-122.08366000000001,
47.615660000000005
],
[
-122.08008000000001,
47.61939
],
[
-122.07904,
47.62201
],
[
-122.07959000000001,
47.627520000000004
],
[
-122.08008000000001,
47.627520000000004
],
[
-122.09181000000001,
47.627520000000004
],
[
-122.09221000000001,
47.62717000000001
],
[
-122.09256,
47.627520000000004
],
[
-122.11094000000001,
47.62765
],
[
-122.11091,
47.636720000000004
],
[
-122.11091,
47.64609
],
[
-122.11431,
47.646060000000006
],
[
-122.11437000000001,
47.64533
],
[
-122.11597,
47.64374
],
[
-122.12254000000001,
47.638510000000004
],
[
-122.12542,
47.636720000000004
],
[
-122.12809000000001,
47.635200000000005
],
[
-122.13241000000001,
47.63515
],
[
-122.13234000000001,
47.63268
],
[
-122.13407000000001,
47.63156000000001
],
[
-122.13484000000001,
47.62935
],
[
-122.13626000000001,
47.62820000000001
],
[
-122.1372,
47.627860000000005
],
[
-122.14184000000002,
47.62787
],
[
-122.14321000000001,
47.62713
],
[
-122.14312000000001,
47.636720000000004
],
[
-122.14335000000001,
47.660590000000006
],
[
-122.1641,
47.66077000000001
],
[
-122.16453000000001,
47.646370000000005
],
[
-122.16797000000001,
47.64621
],
[
-122.19629,
47.64643
],
[
-122.19629,
47.64289
],
[
-122.19846000000001,
47.642860000000006
],
[
-122.19846000000001,
47.64242
],
[
-122.19982000000002,
47.6424
],
[
-122.20169000000001,
47.644600000000004
],
[
-122.20341,
47.643190000000004
],
[
-122.20818000000001,
47.6435
],
[
-122.21014000000001,
47.643130000000006
],
[
-122.20962000000002,
47.642920000000004
],
[
-122.20974000000001,
47.636720000000004
],
[
-122.21005000000001,
47.62107
],
[
-122.22268000000001,
47.62106000000001
],
[
-122.22268000000001,
47.62066
],
[
-122.22203,
47.620470000000005
],
[
-122.22282000000001,
47.619890000000005
],
[
-122.22142000000001,
47.618570000000005
],
[
-122.22248,
47.61838
],
[
-122.22271,
47.617200000000004
],
[
-122.22136,
47.617180000000005
],
[
-122.21985000000001,
47.61643
],
[
-122.22044000000001,
47.614470000000004
],
[
-122.22033,
47.603840000000005
],
[
-122.22043000000001,
47.59682
],
[
-122.21702,
47.59038
],
[
-122.21653,
47.59042
],
[
-122.21572,
47.588240000000006
],
[
-122.21067000000001,
47.58375
],
[
-122.20153,
47.57887
],
[
-122.20227000000001,
47.57864000000001
],
[
-122.20132000000001,
47.578770000000006
],
[
-122.20034000000001,
47.57822
],
[
-122.19901000000002,
47.57592
],
[
-122.19923000000001,
47.567460000000004
],
[
-122.20034000000001,
47.55962
],
[
-122.20072,
47.55966
],
[
-122.20114000000001,
47.557520000000004
],
[
-122.20119000000001,
47.54943
],
[
-122.20160000000001,
47.549440000000004
],
[
-122.20167000000001,
47.54883
],
[
-122.20200000000001,
47.54609000000001
],
[
-122.19676000000001,
47.54621
],
[
-122.19545000000001,
47.54609000000001
],
[
-122.19545000000001,
47.545750000000005
],
[
-122.19091000000002,
47.54580000000001
],
[
-122.1907,
47.54216
],
[
-122.18581,
47.542100000000005
],
[
-122.18116,
47.541140000000006
],
[
-122.17142000000001,
47.54086
],
[
-122.16987,
47.54008
],
[
-122.16797000000001,
47.540060000000004
],
[
-122.16554000000001,
47.54005
],
[
-122.16439000000001,
47.54281
],
[
-122.16433,
47.545480000000005
],
[
-122.15356000000001,
47.54538
],
[
-122.15359000000001,
47.541760000000004
],
[
-122.14280000000001,
47.541520000000006
],
[
-122.14288,
47.539370000000005
],
[
-122.13645000000001,
47.53826
],
[
-122.13035,
47.53502
]
],
[
[
-122.19957000000001,
47.58372000000001
],
[
-122.20448,
47.583830000000006
],
[
-122.20585000000001,
47.586780000000005
],
[
-122.19654000000001,
47.586740000000006
],
[
-122.19655000000002,
47.58379
],
[
-122.19957000000001,
47.58372000000001
]
]
]
}
]
},
"properties": {
"name": "Bellevue",
"copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
"copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
"geometriesCopyright": [
{
"sourceName": "TOM",
"copyright": "TomTom"
}
]
}
}
Définitions
| Nom | Description |
|---|---|
| Boundary |
Notez que le service retourne généralement une GeometryCollection avec des sous-types Polygon ou MultiPolygon. |
|
Boundary |
Propriétés d’un objet Boundary. |
|
Boundary |
Concept géopolitique pour lequel retourner une limite. S’il n’est pas spécifié, la valeur par défaut est |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Feature |
Le type d’une fonctionnalité doit être Feature. |
|
Geo |
Objet geometry |
|
Geo |
Type d’objet |
|
Geo |
Type de géométrie |
|
Geo |
Type de géométrie |
|
Geo |
Type de géométrie |
|
Geo |
Type d’objet |
|
Geo |
Type de géométrie |
|
Geo |
Type de géométrie |
|
Geometry |
Informations de copyright d’une géométrie d’un objet Boundary. |
|
Resolution |
La résolution détermine la quantité de points à renvoyer. S’il n’est pas spécifié, la résolution par défaut est moyenne. |
Boundary
GeoJSON GeocodingFeature objet qui décrivent les limites d’une zone géographique. La géométrie de la fonctionnalité est décrite avec GeoJSON GeometryCollection.
Notez que le service retourne généralement une GeometryCollection avec des sous-types Polygon ou MultiPolygon.
| Nom | Type | Description |
|---|---|---|
| geometry |
Type d’objet |
|
| properties |
Propriétés d’un objet Boundary. |
|
| type |
Le type d’une fonctionnalité doit être Feature. |
BoundaryProperties
Propriétés d’un objet Boundary.
| Nom | Type | Description |
|---|---|---|
| copyright |
string |
Chaîne de copyright. |
| copyrightURL |
string |
URL qui répertorie un grand nombre de fournisseurs de données pour Azure Maps et leurs informations de copyright associées. |
| geometriesCopyright |
Collection d’informations sur le droit d’auteur pour chaque géométrie de l’objet Boundary dans le même ordre qu’elles apparaissent. |
|
| name |
string |
Nom associé à la zone géographique. |
BoundaryResultTypeEnum
Concept géopolitique pour lequel retourner une limite. S’il n’est pas spécifié, la valeur par défaut est countryRegion type de résultat.
| Valeur | Description |
|---|---|
| countryRegion |
Pays ou région. |
| adminDistrict |
Premier niveau administratif au niveau du pays/de la région, tel qu’un état ou une province. |
| adminDistrict2 |
Deuxième niveau administratif au niveau du pays/de la région, tel qu’un comté. |
| postalCode |
La plus petite catégorie de code postal, telle qu’un code postal. |
| postalCode2 |
La catégorie de code postal la plus importante suivante après le code postal créé par l’agrégation des zones postalCode. |
| postalCode3 |
La plus grande catégorie de code post après postalCode2 créée par l’agrégation des zones postalCode2. |
| postalCode4 |
La catégorie de code postal la plus importante suivante après postalCode3 créée par l’agrégation des zones postalCode3. |
| neighborhood |
Une section d’un lieu rempli qui est généralement bien connu, mais souvent avec des limites indistinctes. |
| locality |
Une zone concentrée d’établissement humain, telle qu’une ville, une ville ou un village. |
ErrorAdditionalInfo
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
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
FeatureTypeEnum
Le type d’une fonctionnalité doit être Feature.
| Valeur | Description |
|---|---|
| Feature |
GeoJsonGeometry
Objet geometry GeoJSON valide. Le type doit être l’un des sept types de géométrie GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| type |
Geo |
Spécifie le type |
GeoJsonGeometryCollection
Type d’objet GeoJSON GeometryCollection valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| geometries | GeoJsonGeometry[]: |
Contient une liste d’objets geometry |
| type |
string:
Geometry |
Spécifie le type |
GeoJsonLineString
Type de géométrie GeoJSON LineString valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Coordonnées de la géométrie |
| type |
string:
Line |
Spécifie le type |
GeoJsonMultiLineString
Type de géométrie GeoJSON MultiLineString valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Coordonnées de la géométrie |
| type |
string:
Multi |
Spécifie le type |
GeoJsonMultiPoint
Type de géométrie GeoJSON MultiPoint valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Coordonnées de la géométrie |
| type |
string:
Multi |
Spécifie le type |
GeoJsonMultiPolygon
Type d’objet GeoJSON MultiPolygon valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Contient une liste d’objets |
| type |
string:
Multi |
Spécifie le type |
GeoJsonPoint
Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Un |
| type |
string:
Point |
Spécifie le type |
GeoJsonPolygon
Type de géométrie GeoJSON Polygon valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Coordonnées pour le type de géométrie |
| type |
string:
Polygon |
Spécifie le type |
GeometryCopyright
Informations de copyright d’une géométrie d’un objet Boundary.
| Nom | Type | Description |
|---|---|---|
| copyright |
string |
Chaîne de copyright pour le fournisseur de données |
| sourceName |
string |
Nom du fournisseur de données |
ResolutionEnum
La résolution détermine la quantité de points à renvoyer. S’il n’est pas spécifié, la résolution par défaut est moyenne.
| Valeur | Description |
|---|---|
| small |
Retourne la géométrie de limite avec le moins de points. |
| medium |
Retourne la géométrie de limite avec plus ou la même quantité de points que petites. |
| large |
Retourne la géométrie de limite avec plus ou la même quantité de points que moyen. |
| huge |
Retourne la géométrie de limite avec plus ou la même quantité de points que la taille. |