Spatial - Get Point In Polygon

Referenz

Service:: Maps

API Version:: 2022-08-01

Verwenden Sie, um zu bestimmen, ob sich ein bestimmter Punkt in 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 in 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 MultiPolygon-Geometrien enthalten, andere Geometrien werden ignoriert, wenn diese angegeben werden. Wenn sich der Punkt innerhalb oder auf der Begrenzung 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, ergibt das Ergebnis einen Abschnitt überschneidende Geometrien, um alle gültigen Geometrien (referenziert durch geometryId) in Benutzerdaten anzuzeigen. Die maximale Anzahl von Scheitelpunkten, die zum Bilden eines Polygons akzeptiert werden, beträgt 10.000.

Zum Testen dieser API können Sie die Beispieldaten aus post Point In Polygon API-Beispielen (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	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
geography	path	True	string	Standort des Azure Maps-Kontos. Gültige Werte sind us (USA, Osten, USA, Westen, Mitte, Usa, Westen 2) und eu (Europa, Norden, Europa, Westen). Dieser Parameter ist erforderlich, wenn ein `udid` in der Anforderung angegeben wird. Wenn sich das Azure Maps-Konto beispielsweise in den USA, Osten befindet, werden nur Anfragen 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 der 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. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung 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. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 Azure-Portal, PowerShell, 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 master Schlü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.

Type: apiKey
In: header

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.

Type: apiKey
In: header

Beispiele

GetPointInPolygon

Sample Request

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

Sample Response

Status code:: 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	Gewünschtes Format der Antwort. Nur das `json`-Format wird unterstützt.
LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den 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	Punkt im Polygonergebnisobjekt

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

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

Name	Typ	Beschreibung
json	string	Das Datenaustauschformat der JavaScript-Objektnotation

LatLongPairAbbreviated

Eine Position, die als Breiten- und Längengrad mit den kurznamen "lat" & "lon" dargestellt wird.

Name	Typ	Beschreibung
lat	number	Latitude-Eigenschaft
lon	number	Längengradeigenschaft

PointInPolygonResult

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

Name	Typ	Beschreibung
result	Result	Punkt im Polygonergebnisobjekt
summary	PointInPolygonSummary	Point In Polygon Summary-Objekt

PointInPolygonSummary

Point In Polygon Summary-Objekt

Name	Typ	Beschreibung
information	string	Verarbeitung von Informationen
sourcePoint	LatLongPairAbbreviated	Eine Position, die als Breiten- und Längengrad mit den 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

Punkt im Polygonergebnisobjekt

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