Udostępnij za pośrednictwem


Spatial - Get Point In Polygon

Służy do określania, czy dany punkt znajduje się wewnątrz zestawu wielokątów.

Interfejs Get Point In Polygon API jest żądaniem HTTP GET , które zwraca wartość logiczną wskazującą, czy punkt znajduje się wewnątrz zestawu wielokątów. Zestaw wielokątów jest dostarczany przez plik GeoJSON, który jest przekazywany przy użyciu usługi rejestru danych i przywoływane przez unikatowy identyfikator udid. Plik GeoJSON może zawierać geometrie Polygon i MultiPolygon, inne geometrie zostaną zignorowane, jeśli zostanie podany. Jeśli punkt znajduje się wewnątrz lub na granicy jednego z tych wielokątów, zwracana wartość jest prawdziwa. We wszystkich pozostałych przypadkach zwracana wartość to false. Gdy punkt znajduje się wewnątrz wielu wielokątów, wynik daje przecinające się sekcje geometrii w celu pokazania wszystkich prawidłowych geometrii (przywołyszonych przez geometryId) w danych użytkownika. Maksymalna liczba wierzchołków akceptowanych do utworzenia wielokąta wynosi 10 000.

Aby przetestować ten interfejs API, możesz przekazać przykładowe dane z przykładów interfejsu API Post Point In Polygon ( Treść żądania) przy użyciu usługi rejestru danych i zastąpić element {udid} z przykładowego żądania poniżejudid używanym podczas tworzenia rejestru danych. Aby uzyskać więcej informacji, zobacz Jak utworzyć rejestr danych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
format
path True

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

geography
path True

string

Lokalizacja konta usługi Azure Maps. Prawidłowe wartości to nas (Wschodnie stany USA, Zachodnio-środkowe stany USA, Zachodnie stany USA 2) i eu (Europa Północna, Europa Zachodnia). Ten parametr jest wymagany, gdy udid element jest dostarczany w żądaniu. Jeśli na przykład konto usługi Azure Maps znajduje się w regionie Wschodnie stany USA, zostaną zaakceptowane tylko żądania dotyczące lokalizacji geograficznej.

api-version
query True

string

Numer wersji interfejsu API usługi Azure Maps.

lat
query True

number

Szerokość geograficzna przekazywanej lokalizacji. Przykład: 48.36.

lon
query True

number

Długość geograficzna przekazywanej lokalizacji. Przykład: -124.63.

udid
query True

string

Unikatowy identyfikator używany podczas tworzenia rejestru danych w celu przekazania prawidłowego obiektu FeatureCollection w formacie GeoJSON. Aby uzyskać szczegółowe informacje, zobacz RFC 7946 . Wszystkie właściwości funkcji powinny zawierać geometryIdelement , który służy do identyfikowania geometrii i uwzględnia wielkość liter. Aby uzyskać więcej informacji na temat usługi rejestru danych, zobacz Jak utworzyć rejestr danych.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-id

string

Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Microsoft Entra ID. Reprezentuje unikatowy identyfikator konta usługi Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania usługi Azure Maps. Aby użyć zabezpieczeń identyfikatora Entra firmy Microsoft w usłudze Azure Maps, zobacz następujące artykuły , aby uzyskać wskazówki.

Odpowiedzi

Nazwa Typ Opis
200 OK

PointInPolygonResult

OK

Other Status Codes

ErrorResponse

Wystąpił nieoczekiwany błąd.

Zabezpieczenia

AADToken

Są to przepływy protokołu Microsoft Entra OAuth 2.0 . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure można użyć jej do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

  • Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów Azure SDK lub interfejsów API REST. * Użycie zestawu SDK sieci Web usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Jest to klucz współużytkowany podczas tworzenia zasobu usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne dla konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie dostępu serwer-serwer do interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.

Typ: apiKey
W: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list SYGNATUR dostępu współdzielonego w zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.

Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure oraz szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej bezpieczny niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.

Typ: apiKey
W: header

Przykłady

GetPointInPolygon

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "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"
    ]
  }
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Odpowiedź na błąd

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

PointInPolygonResult

Zwraca wartość true, jeśli punkt znajduje się w obrębie wielokąta, w przeciwnym razie wartość false

PointInPolygonSummary

Punkt w obiekcie podsumowania wielokąta

Result

Punkt w obiekcie wynikowym wielokąta

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

JsonFormat

Żądany format odpowiedzi. Obsługiwany jest tylko json format.

Nazwa Typ Opis
json

string

Format wymiany danych notacji obiektów JavaScript

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

Nazwa Typ Opis
lat

number

Właściwość Szerokość geograficzna

lon

number

Właściwość Długość geograficzna

PointInPolygonResult

Zwraca wartość true, jeśli punkt znajduje się w obrębie wielokąta, w przeciwnym razie wartość false

Nazwa Typ Opis
result

Result

Punkt w obiekcie wynikowym wielokąta

summary

PointInPolygonSummary

Punkt w obiekcie podsumowania wielokąta

PointInPolygonSummary

Punkt w obiekcie podsumowania wielokąta

Nazwa Typ Opis
information

string

Przetwarzanie informacji

sourcePoint

LatLongPairAbbreviated

Lokalizacja reprezentowana jako szerokość geograficzna i długość geograficzna przy użyciu krótkich nazw "lat" & "lon".

udid

string

Unikatowy identyfikator danych (udid) dla przekazanej zawartości. Identyfikator Udid nie ma zastosowania do operacji przestrzennych POST (ustawionych na wartość null)

Result

Punkt w obiekcie wynikowym wielokąta

Nazwa Typ Opis
intersectingGeometries

string[]

Tablica Geometrie

pointInPolygons

boolean

Właściwość Point In Polygons