Search - Get Search Polygon

Referenz

Dienst:: Maps

API-Version:: 1.0

Verwenden Sie, um Polygondaten einer geografischen Gebietsform wie einer Stadt oder einer Länderregion abzurufen.

Die Get Polygon API ist eine HTTP-Anforderung GET , die Geometriedaten zurückgibt, z. B. eine Stadt- oder Landes-/Regionsgliederung für eine Gruppe von Entitäten, die zuvor aus einer Onlinesuchanforderung im GeoJSON-Format abgerufen wurden. Die Geometrie-ID wird im sourceGeometry Objekt unter "geometry" und "id" entweder in einem Search Address oder Search Fuzzy-Aufruf zurückgegeben.

Eine von einem Onlinesuchendpunkt abgerufene Geometrie-ID hat eine begrenzte Lebensdauer. Es wird nicht empfohlen, Geometrie-IDs im persistenten Speicher für eine spätere Empfehlung zu speichern. Es wird erwartet, dass eine Anforderung an die Polygon-Methode innerhalb weniger Minuten nach der Anforderung an die Onlinesuchemethode erfolgt, die die ID bereitgestellt hat. Der Dienst ermöglicht Batchanforderungen mit bis zu 20 Bezeichnern.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps API.
geometries	query	True	string[]	Durch Kommas getrennte Liste von Geometrie-UUIDs, die zuvor aus einer Onlinesuchanforderung abgerufen wurden.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	PolygonResult	OK
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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 Kartenverwaltungs-API abgerufen werden.
ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen.
Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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 bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um ein Shared Access Signature Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

Get the Geometry using the geometry id returned by the previous Search

Beispielanforderung

HTTP

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Beispiel für eine Antwort

Statuscode:: 200

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
GeoJsonFeature	Ein gültiger `GeoJSON Feature` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonFeatureCollection	Ein gültiger `GeoJSON FeatureCollection` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
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 .
GeoJsonGeometryCollection	Ein gültiger `GeoJSON GeometryCollection` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonLineString	Ein gültiger `GeoJSON LineString` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiLineString	Ein gültiger `GeoJSON MultiLineString` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiPoint	Ein gültiger `GeoJSON MultiPoint` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonMultiPolygon	Ein gültiger `GeoJSON MultiPolygon` Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonPoint	Ein gültiger `GeoJSON Point` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
GeoJsonPolygon	Ein gültiger `GeoJSON Polygon` Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
Polygon
PolygonResult	Dieses Objekt wird von einem erfolgreichen Search Polygon-Aufruf zurückgegeben.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GeoJsonFeature

Ein gültiger GeoJSON Feature Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
featureType	string	Der Funktionstyp Der Wert hängt vom Datenmodell ab, zu dem das aktuelle Feature gehört. Einige Datenmodelle verfügen möglicherweise über einen leeren Wert.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	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 .
id	string	Bezeichner für das Feature.
type	string: Feature	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonFeatureCollection

Ein gültiger GeoJSON FeatureCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
features	GeoJsonFeature[]	Enthält eine Liste gültiger `GeoJSON Feature` Objekte.
type	string: FeatureCollection	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

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
type	GeoJsonObjectType	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonGeometryCollection

Ein gültiger GeoJSON GeometryCollection Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Enthält eine Liste gültiger `GeoJSON` Geometrieobjekte. Beachten Sie , dass die Koordinaten in GeoJSON in der Reihenfolge x, y (Längengrad, Breitengrad) liegen.
type	string: GeometryCollection	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonLineString

Ein gültiger GeoJSON LineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson LineString` Geometrie.
type	string: LineString	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiLineString

Ein gültiger GeoJSON MultiLineString Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson MultiLineString` Geometrie.
type	string: MultiLineString	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPoint

Ein gültiger GeoJSON MultiPoint Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für die `GeoJson MultiPoint` Geometrie.
type	string: MultiPoint	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonMultiPolygon

Ein gültiger GeoJSON MultiPolygon Objekttyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Enthält eine Liste gültiger `GeoJSON Polygon` Objekte. Beachten Sie , dass die Koordinaten in GeoJSON in der Reihenfolge x, y (Längengrad, Breitengrad) liegen.
type	string: MultiPolygon	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPoint

Ein gültiger GeoJSON Point Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Ein `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längen- und Breitengrad, genau in dieser Reihenfolge. Höhe/Höhe ist ein optionales drittes Element. Weitere Informationen finden Sie unter RFC 7946 .
type	string: Point	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

GeoJsonPolygon

Ein gültiger GeoJSON Polygon Geometrietyp. Weitere Informationen finden Sie unter RFC 7946 .

Name	Typ	Beschreibung
coordinates	number[]	Koordinaten für den `GeoJson Polygon` geometry-Typ.
type	string: Polygon	Gibt den `GeoJSON`-Typ an. Muss einer der neun gültigen GeoJSON-Objekttypen sein: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature und FeatureCollection.

JsonFormat

Das gewünschte Format der Antwort. Nur das json-Format wird unterstützt.

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

Polygon

Name	Typ	Beschreibung
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Geometriedaten im GeoJSON-Format. Weitere Informationen finden Sie unter RFC 7946 . Nur vorhanden, wenn "error" nicht vorhanden ist.
providerID	string	ID der zurückgegebenen Entität

PolygonResult

Dieses Objekt wird von einem erfolgreichen Search Polygon-Aufruf zurückgegeben.

Name	Typ	Beschreibung
additionalData	Polygon[]	Ergebnisarray

Freigeben über