Spatial - Post Point In Polygon
Slouží k určení, jestli je daný bod uvnitř sady mnohoúhelníku.
Rozhraní Post Point In Polygon
API je požadavek HTTP POST
, který vrací logickou hodnotu označující, jestli je bod uvnitř sady mnohoúhelníku. Uživatelská data mohou obsahovat geometrie Polygon a MultiPolygon, ostatní geometrie budou ignorovány, pokud jsou k dispozici. Pokud je bod uvnitř nebo na hranici jednoho z těchto mnohoúhelníku, je vrácená hodnota true. Ve všech ostatních případech je vrácená hodnota false. Pokud je bod uvnitř více mnohoúhelníku, výsledek poskytne oddíl protínající se geometrie, který zobrazí všechny platné geometrie (odkazované pomocí geometryId) v uživatelských datech. Maximální počet vrcholů přijatých k vytvoření mnohoúhelníku je 10 000.
POST https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&lat={lat}&lon={lon}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi. Podporuje se pouze |
|
geography
|
path | True |
string |
Umístění účtu Azure Maps. Platné hodnoty jsou us (USA – východ, USA – středozápad, USA – západ 2) a eu (Severní Evropa, Západní Evropa). Tento parametr je povinný, pokud |
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
lat
|
query | True |
number |
Zeměpisná šířka předávaného umístění. Příklad: 48,36. |
lon
|
query | True |
number |
Zeměpisná délka předávaného umístění. Příklad: -124,63. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
features | True |
Obsahuje seznam platných |
|
type | True |
string:
Feature |
Určuje |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jedná se o sdílený klíč, který se zřizuje při vytváření Azure Maps prostředku prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.
U veřejně vystavených aplikací doporučujeme používat přístup mezi servery Azure Maps rozhraní REST API, ve kterých lze tento klíč bezpečně uložit.
Type:
apiKey
In:
header
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.
Type:
apiKey
In:
header
Příklady
PostPointInPolygon
Sample Request
POST https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&lat=33.5362475&lon=-111.9267386
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": 1001
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-111.9267386,
33.5362475
],
[
-111.9627875,
33.5104882
],
[
-111.9027061,
33.5004686
],
[
-111.9267386,
33.5362475
]
]
]
}
}
]
}
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 33.5362475,
"lon": -111.9267386
},
"udid": null,
"information": "1 polygons processed in user data"
},
"result": {
"pointInPolygons": true,
"intersectingGeometries": [
"1001"
]
}
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Geo |
Platný |
Json |
Požadovaný formát odpovědi Podporuje se pouze |
Lat |
Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
Point |
Vrátí hodnotu true, pokud se bod nachází v mnohoúhelníku, jinak vrátí hodnotu false. |
Point |
Bod v objektu Souhrn mnohoúhelníku |
Result |
Bod v objektu výsledku mnohoúhelníku |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
GeoJsonFeature
Platný GeoJSON Feature
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
featureType |
string |
Typ funkce. Hodnota závisí na datovém modelu, který je součástí aktuální funkce. Některé datové modely můžou mít prázdnou hodnotu. |
geometry | GeoJsonGeometry: |
Platný |
id |
string |
Identifikátor funkce |
type |
string:
Feature |
Určuje |
GeoJsonFeatureCollection
Platný GeoJSON FeatureCollection
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
features |
Obsahuje seznam platných |
|
type |
string:
Feature |
Určuje |
GeoJsonGeometry
Platný GeoJSON
objekt geometrie. Typ musí být jeden ze sedmi platných typů geometrie GeoJSON – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon a GeometryCollection. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
type |
Geo |
Určuje |
GeoJsonGeometryCollection
Platný GeoJSON GeometryCollection
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Obsahuje seznam platných |
type |
string:
Geometry |
Určuje |
GeoJsonLineString
Platný GeoJSON LineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Line |
Určuje |
GeoJsonMultiLineString
Platný GeoJSON MultiLineString
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Multi |
Určuje |
GeoJsonMultiPoint
Platný GeoJSON MultiPoint
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
|
type |
string:
Multi |
Určuje |
GeoJsonMultiPolygon
Platný GeoJSON MultiPolygon
typ objektu. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Obsahuje seznam platných |
type |
string:
Multi |
Určuje |
GeoJsonPoint
Platný GeoJSON Point
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
A |
type |
string:
Point |
Určuje |
GeoJsonPolygon
Platný GeoJSON Polygon
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
coordinates |
number[] |
Souřadnice typu |
type |
string:
Polygon |
Určuje |
JsonFormat
Požadovaný formát odpovědi Podporuje se pouze json
formát.
Name | Typ | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon".
Name | Typ | Description |
---|---|---|
lat |
number |
Vlastnost Zeměpisná šířka |
lon |
number |
Zeměpisná délka – vlastnost |
PointInPolygonResult
Vrátí hodnotu true, pokud se bod nachází v mnohoúhelníku, jinak vrátí hodnotu false.
Name | Typ | Description |
---|---|---|
result |
Bod v objektu výsledku mnohoúhelníku |
|
summary |
Bod v objektu Souhrn mnohoúhelníku |
PointInPolygonSummary
Bod v objektu Souhrn mnohoúhelníku
Name | Typ | Description |
---|---|---|
information |
string |
Zpracování informací |
sourcePoint |
Umístění vyjádřené jako zeměpisná šířka a délka pomocí krátkých názvů "lat" & "lon". |
|
udid |
string |
Jedinečné ID dat (udid) pro nahraný obsah. Udid se nevztahuje na prostorové operace POST (nastaveno na hodnotu null). |
Result
Bod v objektu výsledku mnohoúhelníku
Name | Typ | Description |
---|---|---|
intersectingGeometries |
string[] |
Matice geometrie |
pointInPolygons |
boolean |
Point in Mnohoúhelníky – vlastnost |