Spatial - Get Point In Polygon

Referenz

Dienst:: Maps

API-Version:: 2022-08-01

Verwenden Sie , um zu bestimmen, ob sich ein bestimmter Punkt innerhalb einer Gruppe von Polygonen befindet.

Die Get Point In Polygon API ist eine HTTP-Anforderung GET , die einen booleschen Wert zurückgibt, der angibt, ob sich ein Punkt innerhalb einer Gruppe von Polygonen befindet. Der Satz von Polygonen wird von einer GeoJSON-Datei bereitgestellt, die mithilfe des Datenregistrierungsdiensts hochgeladen und von einem eindeutigen udid referenziert wird. Die GeoJSON-Datei kann Polygon- und MultiPolygongeometrien enthalten. Andere Geometrien werden ignoriert, wenn sie angegeben werden. Wenn sich der Punkt innerhalb oder an der Grenze eines dieser Polygone befindet, ist der zurückgegebene Wert true. In allen anderen Fällen ist der zurückgegebene Wert false. Wenn sich der Punkt in mehreren Polygonen befindet, gibt das Ergebnis einen abschnitt mit sich überschneidenden Geometrien, um alle gültigen Geometrien (auf die von geometryId verwiesen wird) in Benutzerdaten anzuzeigen. Die maximale Anzahl von Scheitelpunkten, die zum Bilden eines Polygons akzeptiert werden, beträgt 10.000.

Um diese API zu testen, können Sie die Beispieldaten aus Beispielen der Post Point In Polygon-API (Anforderungstext) mithilfe des Datenregistrierungsdiensts hochladen und die {udid} aus der folgenden Beispielanforderung durch die udid beim Erstellen der Datenregistrierung verwendete ersetzen. Weitere Informationen finden Sie unter So erstellen Sie eine Datenregistrierung.

GET https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
format	path	True	JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
geography	path	True	string	Speicherort des Azure Maps-Kontos. Gültige Werte sind us (USA, Osten, USA, Westen-Mitte, USA, Westen-Mitte 2) und eu (Europa, Norden, Europa, Westen). Dieser Parameter ist erforderlich, wenn in der Anforderung angegeben `udid` wird. Wenn sich das Azure Maps-Konto beispielsweise in "USA, Osten" befindet, werden nur Anforderungen an uns geografie akzeptiert.
api-version	query	True	string	Versionsnummer der Azure Maps API.
lat	query	True	number	Der Breitengrad des übergebenen Standorts. Beispiel: 48.36.
lon	query	True	number	Der Längengrad des übergebenen Standorts. Beispiel: -124.63.
udid	query	True	string	Die eindeutige ID, die beim Erstellen einer Datenregistrierung zum Hochladen eines gültigen GeoJSON FeatureCollection-Objekts verwendet wird. Weitere Informationen finden Sie unter RFC 7946 . Alle Eigenschaften des Features sollten enthalten `geometryId`, was zum Identifizieren der Geometrie verwendet wird und die Groß-/Kleinschreibung beachtet. Weitere Informationen zum Datenregistrierungsdienst finden Sie unter Erstellen einer Datenregistrierung.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	PointInPolygonResult	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 von 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-Ressourcenkonten 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.

Hinweise

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-Cloudinstanz. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die 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 Übersicht über 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 verwendeter Schlüssel, der beim Erstellen einer Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs bereitgestellt wird.

Mit diesem Schlüssel ist jede Anwendung für den Zugriff auf alle REST-APIs autorisiert. 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 wird empfohlen, den Server-zu-Server-Zugriff auf Azure Maps-REST-APIs zu verwenden, in denen dieser Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: header

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem SAS-Listenvorgang für die Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, die CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

GetPointInPolygon

Beispielanforderung

HTTP

GET https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=47.622942&lon=-122.316456

Beispiel für eine Antwort

Statuscode:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 33.5362475,
      "lon": -111.9267386
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "4 polygons processed in user data"
  },
  "result": {
    "pointInPolygons": true,
    "intersectingGeometries": [
      "1001",
      "1003"
    ]
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
JsonFormat	Das gewünschte Format der Antwort. Nur das `json`-Format wird unterstützt.
LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
PointInPolygonResult	Gibt true zurück, wenn sich der Punkt innerhalb des Polygons befindet, andernfalls false.
PointInPolygonSummary	Point In Polygon Summary-Objekt
Result	Point In Polygon Result Object

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.

JsonFormat

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

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPairAbbreviated

Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number	Latitude-Eigenschaft
lon	number	Longitude-Eigenschaft

PointInPolygonResult

Gibt true zurück, wenn sich der Punkt innerhalb des Polygons befindet, andernfalls false.

Name	Typ	Beschreibung
result	Result	Point In Polygon Result Object
summary	PointInPolygonSummary	Point In Polygon Summary-Objekt

PointInPolygonSummary

Point In Polygon Summary-Objekt

Name	Typ	Beschreibung
information	string	Verarbeiten von Informationen
sourcePoint	LatLongPairAbbreviated	Ein Ort, der als Breiten- und Längengrad mit dem Kurznamen "lat" & "lon" dargestellt wird.
udid	string	Eine eindeutige Daten-ID (udid) für den hochgeladenen Inhalt. Udid gilt nicht für räumliche POST-Vorgänge (auf NULL festgelegt)

Result

Point In Polygon Result Object

Name	Typ	Beschreibung
intersectingGeometries	string[]	Geometrienarray
pointInPolygons	boolean	Point In Polygons-Eigenschaft

Freigeben über