Search - Get Polygon
Använd för att hämta polygondata för en geografisk områdesform, till exempel en stad eller en landregion.
Get Polygon-API:et är en HTTP-GET begäran som tillhandahåller polygondata för en geografisk områdesdisposition, till exempel en stad eller en landregion.
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-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Maps-tjänstens värdnamn. Använd |
|
api-version
|
query | True |
string minLength: 1 |
Den API-version som ska användas för den här åtgärden. |
|
coordinates
|
query | True |
number[] |
En punkt på jorden som anges som longitud och latitud. Exempel: &koordinater=lon,lat |
|
resolution
|
query |
Lösningen avgör hur många punkter som ska skickas tillbaka. Om det inte anges är standardvärdet medelhög upplösning. |
||
|
result
|
query |
Det geopolitiska begreppet att returnera en gräns för. Om det inte anges är standardvärdet |
||
|
view
|
query |
string |
En sträng som representerar en ISO 3166-1 Alpha-2-region/landskod. Detta ändrar geopolitiska omtvistade kantlinjer och etiketter så att de överensstämmer med den angivna användarregionen. Som standard är view-parametern inställd på "Auto" även om du inte har definierat den i begäran. Mer information finns i vyer som stöds och för att se tillgängliga vyer. |
Begärandehuvud
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Specificerar vilket konto som är avsett för användning i kombination med Azure AD:s säkerhetsmodell. Den representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Azure Maps management plane Account API. För mer information om hur man använder Microsoft Entra ID säkerhet i Azure Maps, se Hantera autentisering i Azure Maps. |
|
| Accept-Language |
string |
Språk där sökresultat ska returneras. Mer information finns i språk som stöds. |
Svar
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Begäran har slutförts. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Ett oväntat felsvar. Media Types: "application/geo+json", "application/json" Sidhuvuden x-ms-error-code: string |
Säkerhet
AadToken
Dessa är Microsoft Entra OAuth 2.0 flöden. När den kombineras med Azure rollbaserad åtkomst kontroll kan den användas för att kontrollera åtkomst till Azure Maps REST-API:er. Azure:s rollbaserade åtkomstkontroller används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller delresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.
Note
- Den här säkerhetsdefinitionen kräver användningen av
x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et. -
Authorization URLär specifik för den offentliga Azure-molninstansen. Suveräna moln har unika auktoriserings-URL:er och Microsoft Entra ID-konfigurationer. - Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
- Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du Skapa ett Azure Maps-konto i Azure-portalen eller med hjälp av PowerShell, CLI, Azure SDK:er eller REST API.
Med den här nyckeln kan alla program komma åt alla REST API:er. Med andra ord kan den här nyckeln användas som en huvudnyckel i det konto som de har utfärdats i.
För offentligt exponerade program rekommenderar vi att du använder konfidentiella klientprogram metod för åtkomst till Azure Maps REST-API:er så att din nyckel kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från sas-åtgärden Lista på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll till förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett mer säkert sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på Map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Get polygon for a city at coordinates -122.204141,47.612560
Exempelbegäran
GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Exempelsvar
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"
}
]
}
}
Definitioner
| Name | Description |
|---|---|
|
Azure. |
Felobjektet. |
|
Azure. |
Ett svar som innehåller felinformation. |
|
Azure. |
Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Boundary |
Den lyckade responskroppen returnerades med |
|
Boundary |
Nyttolasten |
|
Boundary |
Den geografiska hierarkinivån efterfrågas vid anrop |
|
Feature |
Objekttypen |
|
Geo |
En giltig |
|
Geo |
En giltig |
|
Geo |
En giltig |
|
Geo |
En giltig |
|
Geo |
En giltig |
|
Geo |
Anger |
|
Geo |
En giltig |
|
Geo |
En giltig |
|
Geometry |
En enda per-geometrisk dataleverantörsattributionspost inom |
|
Resolution |
Detaljnivån som används för polygonen |
Azure.Core.Foundations.Error
Felobjektet.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| details |
En matris med information om specifika fel som ledde till det rapporterade felet. |
|
| innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
| message |
string |
En mänsklig läsbar representation av felet. |
| target |
string |
Målet för felet. |
Azure.Core.Foundations.ErrorResponse
Ett svar som innehåller felinformation.
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
Azure.Core.Foundations.InnerError
Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Name | Typ | Description |
|---|---|---|
| code |
string |
En av en serverdefinierad uppsättning felkoder. |
| innererror |
Inre fel. |
Boundary
Den lyckade responskroppen returnerades med Get Polygon. Kodad som en GeoJSON Feature vars är en GeometryCollection av en eller flera Polygon former MultiPolygon som beskriver konturerna av det begärda geografiska området, och vars properties bär områdets visningsnamn och upphovsrättsangivelsegeometry.
| Name | Typ | Description |
|---|---|---|
| geometry |
En |
|
| properties |
Visningsnamn och upphovsrättsrätt för det returnerade området. Se |
|
| type |
Objekttypen |
BoundaryProperties
Nyttolasten properties från en Boundary. Bär, visningsnamnet för det returnerade geografiska området tillsammans med upphovsrättserkännande, både en API-omfattande notis och per-geometriska dataleverantörskrediter.
| Name | Typ | Description |
|---|---|---|
| copyright |
string |
Azure Maps API upphovsrätts- och användningsmeddelande som gäller för detta svar. Till skillnad från de per-geometriska dataleverantörsattributionerna i |
| copyrightUrl |
string |
En URL till Azure Maps upphovsrätts- och licensinformation för API:et och dess underliggande datakällor. |
| geometriesCopyright |
Per-geometrisk dataleverantörsattribution. Varje post motsvarar positionsmässigt den matchande formen i modermatrisen |
|
| name |
string |
Visningsnamnet på det geografiska området, till exempel |
BoundaryResultTypeEnum
Den geografiska hierarkinivån efterfrågas vid anrop Get Polygon. Värdet anges som resultType frågeparameter och väljer vilken nivå i den administrativa eller postliga hierarkin den returnerade Boundary polygonen beskriver. Standardvärdet är countryRegion när det inte har angetts.
| Värde | Description |
|---|---|
| countryRegion |
Ett land eller en region. |
| adminDistrict |
Första administrativa nivån inom landet/regionen, såsom en delstat eller en provins. |
| adminDistrict2 |
Andra administrativa nivån inom landet/regionen, såsom ett län. |
| postalCode |
Den minsta postnummerkategorin, såsom ett postnummer. |
| postalCode2 |
Den näst största postnummerkategorin efter |
| postalCode3 |
Den näst största postnummerkategorin efter |
| postalCode4 |
Den näst största postnummerkategorin efter |
| neighborhood |
Ett lokalt erkänt område inom en befolkad plats, ofta med informella eller kulturellt definierade gränser. |
| locality |
Ett koncentrerat område av mänsklig bosättning, såsom en stad, stad eller by. |
FeatureTypeEnum
Objekttypen GeoJSON för Feature objekt. Taggar varje post inom arrayen features av ett FeatureCollection svar (geokodning, omvänd geokodning, autokomplettering) och visas vid roten av svaret Get Polygon . Det enda värdet är Feature, enligt definitionen i RFC 7946.
| Värde | Description |
|---|---|
| Feature |
Objekttypen |
GeoJsonGeometryCollection
En giltig GeoJSON GeometryCollection objekttyp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| geometries | GeoJsonGeometry[]: |
Innehåller en lista över giltiga |
| type |
string:
Geometry |
Anger |
GeoJsonLineString
En giltig GeoJSON LineString geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
Koordinater för |
| type |
string:
Line |
Anger |
GeoJsonMultiLineString
En giltig GeoJSON MultiLineString geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
Koordinater för |
| type |
string:
Multi |
Anger |
GeoJsonMultiPoint
En giltig GeoJSON MultiPoint geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
Koordinater för |
| type |
string:
Multi |
Anger |
GeoJsonMultiPolygon
En giltig GeoJSON MultiPolygon objekttyp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
Innehåller en lista över giltiga |
| type |
string:
Multi |
Anger |
GeoJsonObjectType
Anger GeoJSON typ. Måste vara en av de nio giltiga GeoJSON-objekttyperna – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature och FeatureCollection.
| Värde | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
|
| FeatureCollection |
|
GeoJsonPoint
En giltig GeoJSON Point geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
En |
| type |
string:
Point |
Anger |
GeoJsonPolygon
En giltig GeoJSON Polygon geometrityp. Mer information finns i RFC 7946.
| Name | Typ | Description |
|---|---|---|
| bbox |
number[] (double) |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946. |
| coordinates |
number[] (double) |
Koordinater för |
| type |
string:
Polygon |
Anger |
GeometryCopyright
En enda per-geometrisk dataleverantörsattributionspost inom BoundaryProperties.geometriesCopyright. Identifierar källan till en geometri i modermatrisen Boundary.geometry.geometries .
| Name | Typ | Description |
|---|---|---|
| copyright |
string |
Den människoläsbara attributionssträngen för dataleverantören. Till exempel |
| sourceName |
string |
En identifierare för dataleverantören som levererade denna geometri. |
ResolutionEnum
Detaljnivån som används för polygonen Boundary returneras av Get Polygon. Som frågeparameter resolution väljer värdet hur många punkter som markerar gränsen, i stigande ordning: small, medium, large, . huge Högre nivåer använder lika många poäng som nästa lägre nivå eller fler. Standardvärdet är medium när det inte har angetts.
| Värde | Description |
|---|---|
| small |
Returnerar gränsgeometrin med minst möjliga punkter. |
| medium |
Returnerar randgeometrin med samma antal punkter som |
| large |
Returnerar randgeometrin med samma antal punkter som |
| huge |
Returnerar randgeometrin med samma antal punkter som |