Search - Get Search Polygon

Referenz

Dienst:: Maps

API-Version:: 1.0

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 Geometriedaten zurückgibt, z. B. eine Orts- oder 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" in einem Suchadresse- oder Such-Fuzzy-Aufruf zurückgegeben.

Eine Geometrie-ID, die von einem Onlinesuchendpunkt abgerufen wurde, hat eine begrenzte Lebensdauer, es wird nicht empfohlen, Geometrie-IDs im permanenten Speicher für spätere Verweise zu speichern. Es wird erwartet, dass innerhalb weniger Minuten nach der Anforderung an die Onlinesuchmethode, die die ID bereitgestellt hat, eine Anforderung an die Polygon-Methode gestellt wird. Der Dienst ermöglicht Batchanforderungen bis zu 20 Bezeichner.

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 `json` Format wird unterstützt.
api-version	query	True	string	Versionsnummer der Azure Maps-API.
geometries	query	True	string[]	Durch Trennzeichen 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 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. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Antworten

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

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 Kartenverwaltung API erworben werden.
Die Authorization URL ist 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 freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

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 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	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das 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	Gewünschtes Format der Antwort. Nur `json` Format wird unterstützt.
Polygon
PolygonResult	Dieses Objekt wird von einem erfolgreichen Search Polygon-Aufruf zurückgegeben.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

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

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GeoJsonFeature

Objekt

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

Name	Typ	Beschreibung
featureType	string	Der Typ des Features. Der Wert hängt vom Datenmodell ab, zu dem das aktuelle Feature gehört. Einige Datenmodelle weisen möglicherweise einen leeren Wert auf.
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

Objekt

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

Objekt

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

Objekt

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 koordinaten in GeoJSON in x, y Reihenfolge (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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	Enthält eine Liste gültiger `GeoJSON Polygon` Objekte. Beachten Sie, dass koordinaten in GeoJSON in x, y Reihenfolge (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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	Ein `Position` ist ein Array von Zahlen mit zwei oder mehr Elementen. Die ersten beiden Elemente sind Längengrad und Breitengradgenau in dieser Reihenfolge. Altitude/Elevation 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

Objekt

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

Name	Typ	Beschreibung
coordinates	number[] (double)	Koordinaten für den geometrietyp `GeoJson Polygon`.
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

Enumeration

Gewünschtes Format der Antwort. Nur json Format wird unterstützt.

Wert	Beschreibung
json	das JavaScript Object Notation Data Interchange Format

Polygon

Objekt

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

PolygonResult

Objekt

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

Name	Typ	Beschreibung
additionalData	Polygon[]	Ergebnisarray

Freigeben über

Search - Get Search Polygon

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Bereiche

subscription-key

SAS Token

Beispiele

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

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Zusätzliche Ressourcen