Search - Get Polygon
Dient zum Abrufen von Polygondaten eines geografischen Bereichs, z. B. einer Stadt oder einer Landregion.
Die Get Polygon-API ist eine HTTP-GET Anforderung, die Polygondaten eines geografischen Bereichs bereitstellt, z. B. eine Stadt oder eine Landregion.
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}
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Versionsnummer der Azure Maps-API. |
|
coordinates
|
query | True |
number[] |
Ein Punkt auf der Erde, der als Längengrad und Breitengrad angegeben ist. Beispiel: &Koordinaten=lon,lat |
|
resolution
|
query |
Die Auflösung bestimmt die Anzahl der zurückzusendenden Punkte. Wenn nicht angegeben, ist die Standardauflösung mittelgroß. |
||
|
result
|
query |
Das geopolitische Konzept, für das eine Grenze zurückgegeben werden soll. Wenn nicht angegeben, ist der Standardwert |
||
|
view
|
query |
string |
Eine Zeichenfolge, die eine ISO 3166-1 Alpha-2-Region/Ländercodedarstellt. Dies wird geopolitische umstrittene Grenzen und Bezeichnungen ändern, um sie an die angegebene Benutzerregion auszurichten. Der Parameter "View" ist standardmäßig auf "Auto" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Weitere Informationen finden Sie unter Unterstützten Ansichten und die verfügbaren Ansichten. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-id |
string |
Gibt an, welches Konto in Verbindung mit dem Azure AD-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Weitere Informationen zur Verwendung der Microsoft Entra ID-Sicherheit in Azure Maps finden Sie unter Verwalten der Authentifizierung in Azure Maps. |
|
| Accept-Language |
string |
Sprache, in der Suchergebnisse zurückgegeben werden sollen. Weitere Informationen finden Sie unter unterstützten Sprachen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
OKAY Media Types: "application/geo+json" |
|
| Other Status Codes |
Ein unerwarteter Fehler ist aufgetreten. Media Types: "application/geo+json" |
Sicherheit
AADToken
Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.
Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.
Hinweis
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden. - Die
Authorization URList spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. - Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
- Die Verwendung des Azure Maps Web SDK ermöglicht das konfigurationsbasierte Einrichten einer Anwendung für mehrere Anwendungsfälle.
- Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Dies ist ein gemeinsam genutzter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs bereitgestellt wird.
Mit diesem Schlüssel ist jede Anwendung berechtigt, auf alle REST-APIs zuzugreifen. Mit anderen Worten, diese können derzeit als Hauptschlüssel für das Konto behandelt werden, für das sie ausgestellt werden.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, den Server-zu-Server-Zugriff von Azure Maps-REST-APIs zu verwenden, bei denen dieser Schlüssel sicher gespeichert werden kann.
Typ:
apiKey
In:
header
SAS Token
Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.
Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.
Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.
Typ:
apiKey
In:
header
Beispiele
Get polygon for a city at coordinates -122.204141,47.612560
Beispielanforderung
GET https://atlas.microsoft.com/search/polygon?api-version=2025-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Beispiel für eine Antwort
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"
}
]
}
}
Definitionen
| Name | Beschreibung |
|---|---|
| Boundary |
Bitte beachten Sie, dass der Dienst in der Regel eine GeometryCollection mit Polygon- oder MultiPolygon-Untertypen zurückgibt. |
|
Boundary |
Eigenschaften eines Boundary-Objekts. |
|
Boundary |
Das geopolitische Konzept, für das eine Grenze zurückgegeben werden soll. Wenn nicht angegeben, ist der Standardwert |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Feature |
Der Typ eines Features muss feature sein. |
|
Geo |
Ein gültiges |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geo |
Ein gültiger |
|
Geometry |
Copyrightinformationen einer Geometrie eines Boundary-Objekts. |
|
Resolution |
Die Auflösung bestimmt die Anzahl der zurückzusendenden Punkte. Wenn nicht angegeben, ist die Standardauflösung mittelgroß. |
Boundary
GeoJSON GeocodingFeature Objekt, das die Grenzen eines geografischen Gebiets beschreibt. Geometrie des Features wird mit GeoJSON GeometryCollectionbeschrieben.
Bitte beachten Sie, dass der Dienst in der Regel eine GeometryCollection mit Polygon- oder MultiPolygon-Untertypen zurückgibt.
| Name | Typ | Beschreibung |
|---|---|---|
| geometry |
Ein gültiger |
|
| properties |
Eigenschaften eines Boundary-Objekts. |
|
| type |
Der Typ eines Features muss feature sein. |
BoundaryProperties
Eigenschaften eines Boundary-Objekts.
| Name | Typ | Beschreibung |
|---|---|---|
| copyright |
string |
Die Copyright-Zeichenfolge. |
| copyrightURL |
string |
Eine URL, die viele der Datenanbieter für Azure Maps und deren zugehörige Copyrightinformationen auflistet. |
| geometriesCopyright |
Eine Sammlung von Copyrightinformationen für jede Geometrie des Boundary-Objekts in derselben Reihenfolge, in der sie angezeigt werden. |
|
| name |
string |
Der Name, der dem geografischen Gebiet zugeordnet ist. |
BoundaryResultTypeEnum
Das geopolitische Konzept, für das eine Grenze zurückgegeben werden soll. Wenn nicht angegeben, ist der Standardwert countryRegion Ergebnistyp.
| Wert | Beschreibung |
|---|---|
| countryRegion |
Land oder Region. |
| adminDistrict |
Erste Verwaltungsebene innerhalb der Landes-/Regionsebene, z. B. eines Staates oder einer Provinz. |
| adminDistrict2 |
Zweite Verwaltungsebene innerhalb der Landes-/Regionsebene, z. B. eines Landkreises. |
| postalCode |
Die kleinste Postcodekategorie, z. B. eine Postleitzahl. |
| postalCode2 |
Die nächste größte Postcodekategorie nach der Postleitzahl, die durch Aggregieren von Postleitzahlenbereichen erstellt wird. |
| postalCode3 |
Die nächste größte Postcodekategorie nach Postleitzahl2, die durch Aggregieren von Postleitzahlen2-Bereichen erstellt wird. |
| postalCode4 |
Die nächste größte Postcodekategorie nach Postleitzahl3, die durch Aggregieren von Postleitzahlen3-Bereichen erstellt wird. |
| neighborhood |
Ein Abschnitt eines ausgefüllten Ortes, der in der Regel gut bekannt ist, aber häufig mit undifferenzierten Grenzen. |
| locality |
Ein konzentrierter Bereich der menschlichen Siedlung, z. B. eine Stadt, eine Stadt oder ein Dorf. |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
object |
Die zusätzlichen Informationen. |
| type |
string |
Der zusätzliche Informationstyp. |
ErrorDetail
Das Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
FeatureTypeEnum
Der Typ eines Features muss feature sein.
| Wert | Beschreibung |
|---|---|
| Feature |
GeoJsonGeometry
Ein gültiges GeoJSON Geometry-Objekt. Der Typ muss einer der sieben gültigen GeoJSON-Geometrietypen sein : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon und GeometryCollection. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| type |
Geo |
Gibt den |
GeoJsonGeometryCollection
Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| geometries | GeoJsonGeometry[]: |
Enthält eine Liste gültiger |
| type |
string:
Geometry |
Gibt den |
GeoJsonLineString
Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Line |
Gibt den |
GeoJsonMultiLineString
Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Multi |
Gibt den |
GeoJsonMultiPoint
Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Koordinaten für die |
| type |
string:
Multi |
Gibt den |
GeoJsonMultiPolygon
Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Enthält eine Liste gültiger |
| type |
string:
Multi |
Gibt den |
GeoJsonPoint
Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Ein |
| type |
string:
Point |
Gibt den |
GeoJsonPolygon
Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946-.
| Name | Typ | Beschreibung |
|---|---|---|
| bbox |
number[] (double) |
Begrenzungsrahmen. Projektion verwendet - EPSG:3857. Weitere Informationen finden Sie unter RFC 7946-. |
| coordinates |
number[] (double) |
Koordinaten für den geometrietyp |
| type |
string:
Polygon |
Gibt den |
GeometryCopyright
Copyrightinformationen einer Geometrie eines Boundary-Objekts.
| Name | Typ | Beschreibung |
|---|---|---|
| copyright |
string |
Die Copyright-Zeichenfolge für den Datenanbieter |
| sourceName |
string |
Der Name des Datenanbieters |
ResolutionEnum
Die Auflösung bestimmt die Anzahl der zurückzusendenden Punkte. Wenn nicht angegeben, ist die Standardauflösung mittelgroß.
| Wert | Beschreibung |
|---|---|
| small |
Gibt die Begrenzungsgeometrie mit der geringsten Punktmenge zurück. |
| medium |
Gibt die Begrenzungsgeometrie mit mehr oder derselben Punktmenge wie klein zurück. |
| large |
Gibt die Begrenzungsgeometrie mit mehr oder derselben Punktmenge wie mittel zurück. |
| huge |
Gibt die Begrenzungsgeometrie mit mehr oder derselben Punktmenge wie groß zurück. |