Search - Get Polygon
Gebruik deze functie om veelhoekgegevens op te halen van een geografische gebiedsvorm, zoals een stad of een landregio.
De Get Polygon API is een HTTP-verzoek GET dat polygoongegevens levert van een geografisch gebied, zoals een stad of een landregio.
GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}
GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
URI-parameters
| Name | In | Vereist | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
De hostnaam van de Azure Maps-service. Gebruik |
|
api-version
|
query | True |
string minLength: 1 |
De API-versie die voor deze bewerking moet worden gebruikt. |
|
coordinates
|
query | True |
number[] |
Een punt op de aarde gespecificeerd als een lengte- en breedtegraad. Voorbeeld: &coördinaten=lon,lat |
|
resolution
|
query |
Resolutie bepaalt het aantal punten dat moet worden teruggestuurd. Als dit niet is opgegeven, is de standaardinstelling gemiddelde resolutie. |
||
|
result
|
query |
Het geopolitieke concept om een grens voor terug te geven. Als dit niet is opgegeven, is |
||
|
view
|
query |
string |
Een tekenreeks die een ISO 3166-1 alfa-2 regio/landcodevertegenwoordigt. Hierdoor worden geopolitieke grenzen en labels gewijzigd zodat deze overeenkomen met de opgegeven gebruikersregio. De parameter Weergave is standaard ingesteld op Automatisch, zelfs als u deze niet hebt gedefinieerd in de aanvraag. Raadpleeg ondersteunde weergaven voor meer informatie en om de beschikbare weergaven te bekijken. |
Aanvraagkoptekst
| Name | Vereist | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Specificeert welk account bedoeld is voor gebruik in combinatie met het Azure AD-beveiligingsmodel. Het vertegenwoordigt een unieke ID voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheerplane Account API. Voor meer informatie over het gebruik van Microsoft Entra ID beveiliging in Azure Maps, zie Beheer authenticatie in Azure Maps. |
|
| Accept-Language |
string |
Taal waarin zoekresultaten moeten worden geretourneerd. Raadpleeg ondersteunde talen voor meer informatie. |
Antwoorden
| Name | Type | Description |
|---|---|---|
| 200 OK |
De aanvraag is voltooid. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Een onverwachte foutreactie. Media Types: "application/geo+json", "application/json" Kopteksten x-ms-error-code: string |
Beveiliging
AadToken
Dit zijn de Microsoft Entra OAuth 2.0 stromen. In combinatie met Azure rolgebaseerde toegang control kan het worden gebruikt om de toegang tot Azure Maps REST-API's te controleren. Azure rolgebaseerde toegangscontroles worden gebruikt om toegang aan een of meer Azure Maps-resourceaccounts of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.
Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.
Note
- Deze beveiligingsdefinitie vereist het gebruik van de
x-ms-client-id-header om aan te geven tot welke Azure Maps-resource de toepassing toegang aanvraagt. Dit kan worden verkregen uit de Maps Management API-. - De
Authorization URLis specifiek voor het exemplaar van de openbare Azure-cloud. Sovereign clouds hebben unieke autorisatie-URL's en Microsoft Entra ID-configuraties. - Het op rollen gebaseerde toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
- Gebruik van de Azure Maps Web SDK maakt configuratiegebaseerde installatie van een toepassing mogelijk voor meerdere gebruiksscenario's.
- Zie Overzicht van Microsoft Identity Platformvoor meer informatie over het Microsoft Identity Platform.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Dit is een gedeelde sleutel die wordt ingericht wanneer u Een Azure Maps-account maken in Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.
Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze worden uitgegeven.
Voor openbaar blootgestelde toepassingen is het raadzaam om de vertrouwelijke clienttoepassingen te gebruiken benadering voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.
Type:
apiKey
In:
header
SAS Token
Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.
Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.
Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.
Type:
apiKey
In:
header
Voorbeelden
Get polygon for a city at coordinates -122.204141,47.612560
Voorbeeldaanvraag
GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Voorbeeldrespons
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"
}
]
}
}
Definities
| Name | Description |
|---|---|
|
Azure. |
Het foutobject. |
|
Azure. |
Een antwoord met foutdetails. |
|
Azure. |
Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Boundary |
Het succesvolle responslichaam werd teruggegeven door |
|
Boundary |
De |
|
Boundary |
Het geografische hiërarchieniveau wordt gevraagd bij het aanroepen |
|
Feature |
Het |
|
Geo |
Een geldig |
|
Geo |
Een geldig |
|
Geo |
Een geldig |
|
Geo |
Een geldig |
|
Geo |
Een geldig |
|
Geo |
Hiermee geeft u het |
|
Geo |
Een geldig |
|
Geo |
Een geldig |
|
Geometry |
Een enkele per-geometrie data-provider attributie-invoer binnen |
|
Resolution |
Het detailniveau dat voor de veelhoek wordt gebruikt, |
Azure.Core.Foundations.Error
Het foutobject.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| details |
Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout. |
|
| innererror |
Een object met meer specifieke informatie dan het huidige object over de fout. |
|
| message |
string |
Een leesbare weergave van de fout. |
| target |
string |
Het doel van de fout. |
Azure.Core.Foundations.ErrorResponse
Een antwoord met foutdetails.
| Name | Type | Description |
|---|---|---|
| error |
Het foutobject. |
Azure.Core.Foundations.InnerError
Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Type | Description |
|---|---|---|
| code |
string |
Een van een door de server gedefinieerde set foutcodes. |
| innererror |
Interne fout. |
Boundary
Het succesvolle responslichaam werd teruggegeven door Get Polygon. Gecodeerd als een GeoJSON Feature waarvan een geometryGeometryCollection vorm bestaat uit een of meer PolygonMultiPolygon vormen die de omtrek van het gevraagde geografische gebied beschrijven, en waarvan de properties weergavenaam van het gebied en auteursrechtelijke verheffing dragen.
| Name | Type | Description |
|---|---|---|
| geometry |
Een |
|
| properties |
Weergavenaam en auteursrechtelijke toeschrijving voor het teruggegeven gebied. Zie |
|
| type |
Het |
BoundaryProperties
De properties lading van een Boundary. Draagt de weergavenaam van het teruggegeven geografische gebied samen met auteursrechtelijke toeschrijving, zowel een API-brede kennisgeving als per-geometrische dataprovidercredits.
| Name | Type | Description |
|---|---|---|
| copyright |
string |
De Azure Maps API copyright- en gebruiksmelding die op dit antwoord van toepassing is. Verschillend van de per-geometrie data-provider-attributies in |
| copyrightUrl |
string |
Een URL naar Azure Maps auteursrecht- en licentie-informatie voor de API en de onderliggende gegevensbronnen. |
| geometriesCopyright |
Per-geometrie dataprovider-attributie. Elke invoer komt positioneel overeen met de bijpassende vorm in de ouderarray |
|
| name |
string |
De weergavenaam van het geografische gebied, bijvoorbeeld |
BoundaryResultTypeEnum
Het geografische hiërarchieniveau wordt gevraagd bij het aanroepen Get Polygonvan . De waarde wordt als queryparameter resultType gegeven en selecteert welk niveau van de administratieve of postuele hiërarchie de teruggegeven Boundary polygon omvat. Wordt standaard ingesteld op countryRegion als dit niet is opgegeven.
| Waarde | Description |
|---|---|
| countryRegion |
Een land of regio. |
| adminDistrict |
Eerste administratieve niveau binnen het land/de regio, zoals een staat of een provincie. |
| adminDistrict2 |
Tweede administratief niveau binnen het land/de regio, zoals een county. |
| postalCode |
De kleinste postcodecategorie, zoals een postcode. |
| postalCode2 |
De op één na grootste postcodecategorie daarna |
| postalCode3 |
De op één na grootste postcodecategorie daarna |
| postalCode4 |
De op één na grootste postcodecategorie daarna |
| neighborhood |
Een lokaal erkend gebied binnen een bevolkte plek, vaak met informele of cultureel gedefinieerde grenzen. |
| locality |
Een geconcentreerd gebied van menselijke nederzettingen, zoals een stad, dorp of dorp. |
FeatureTypeEnum
Het GeoJSON objecttype voor Feature objecten. Tagt elke invoer binnen de features array van een FeatureCollection respons (geocodering, reverse geocoding, autocomplete) en verschijnt aan de wortel van de Get Polygon respons. De enige waarde is Feature, zoals gedefinieerd in RFC 7946.
| Waarde | Description |
|---|---|
| Feature |
Het |
GeoJsonGeometryCollection
Een geldig GeoJSON GeometryCollection objecttype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| geometries | GeoJsonGeometry[]: |
Bevat een lijst met geldige |
| type |
string:
Geometry |
Hiermee geeft u het |
GeoJsonLineString
Een geldig GeoJSON LineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Coördinaten voor de |
| type |
string:
Line |
Hiermee geeft u het |
GeoJsonMultiLineString
Een geldig GeoJSON MultiLineString geometrietype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Coördinaten voor de |
| type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPoint
Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Coördinaten voor de |
| type |
string:
Multi |
Hiermee geeft u het |
GeoJsonMultiPolygon
Een geldig GeoJSON MultiPolygon objecttype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Bevat een lijst met geldige |
| type |
string:
Multi |
Hiermee geeft u het |
GeoJsonObjectType
Hiermee geeft u het GeoJSON type. Moet een van de negen geldige GeoJSON-objecttypen zijn: Punt, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature en FeatureCollection.
| Waarde | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
Een geldig GeoJSON Point geometrietype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Een |
| type |
string:
Point |
Hiermee geeft u het |
GeoJsonPolygon
Een geldig GeoJSON Polygon geometrietype. Raadpleeg RFC 7946- voor meer informatie.
| Name | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Begrenzingsvak. Gebruikte projectie - EPSG:3857. Raadpleeg RFC 7946- voor meer informatie. |
| coordinates |
number[] (double) |
Coördinaten voor het type |
| type |
string:
Polygon |
Hiermee geeft u het |
GeometryCopyright
Een enkele per-geometrie data-provider attributie-invoer binnen BoundaryProperties.geometriesCopyright. Identificeert de bron van één geometrie in de ouderarray Boundary.geometry.geometries .
| Name | Type | Description |
|---|---|---|
| copyright |
string |
De mensleesbare attributiestring voor de gegevensleverancier. Bijvoorbeeld: |
| sourceName |
string |
Een identificatie voor de dataprovider die deze geometrie leverde. |
ResolutionEnum
Het detailniveau dat voor de veelhoek wordt gebruikt, Boundary wordt teruggegeven door Get Polygon. Als queryparameter resolution wordt de waarde gegeven en selecteert hoeveel punten de grens omlijnen, in oplopende volgorde: small, medium, large, . huge Hogere niveaus gebruiken hetzelfde aantal punten als het volgende lagere niveau of meer. Wordt standaard ingesteld op medium als dit niet is opgegeven.
| Waarde | Description |
|---|---|
| small |
Geeft de grensgeometrie terug met de minste punten. |
| medium |
Geeft de grensgeometrie terug met hetzelfde aantal punten als |
| large |
Geeft de grensgeometrie terug met hetzelfde aantal punten als |
| huge |
Geeft de grensgeometrie terug met hetzelfde aantal punten als |