Spatial - Get Point In Polygon
Utilisez pour déterminer si un point donné se trouve à l’intérieur d’un ensemble de polygones.
L’API Get Point In Polygon
est une requête HTTP GET
qui retourne une valeur booléenne indiquant si un point se trouve à l’intérieur d’un ensemble de polygones. L’ensemble de polygones est fourni par un fichier GeoJSON qui est chargé à l’aide du service du Registre de données et référencé par un udid unique. Le fichier GeoJSON peut contenir des géométries Polygon et MultiPolygon. D’autres géométries seront ignorées si elles sont fournies. Si le point se trouve à l’intérieur ou sur la limite de l’un de ces polygones, la valeur retournée est true. Dans tous les autres cas, la valeur retournée est false. Lorsque le point se trouve à l’intérieur de plusieurs polygones, le résultat donne une section de géométries croisées pour afficher toutes les géométries valides (référencées par geometryId) dans les données utilisateur. Le nombre maximal de sommets acceptés pour former un polygone est de 10 000.
Pour tester cette API, vous pouvez charger les exemples de données à partir d’exemples d’API Post Point in Polygon (Corps de la requête) à l’aide du service Registre de données et remplacer le {udid}
de l’exemple de requête ci-dessous par le udid
utilisé lors de la création du registre de données. Pour plus d'informations, consultez Guide pratique pour créer un registre de données.
GET https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
format
|
path | True |
Format souhaité de la réponse. Seul le format |
|
geography
|
path | True |
string |
Emplacement du compte Azure Maps. Les valeurs valides sont us (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest). Ce paramètre est requis lorsqu’un |
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
lat
|
query | True |
number |
Latitude de l’emplacement passé. Exemple : 48.36. |
lon
|
query | True |
number |
Longitude de l’emplacement passé. Exemple : -124.63. |
udid
|
query | True |
string |
ID unique utilisé lors de la création d’un registre de données pour charger un objet GeoJSON FeatureCollection valide. Pour plus d’informations, consultez RFC 7946 . Toutes les propriétés de la fonctionnalité doivent contenir |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
x-ms-client-id |
string |
Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok |
|
Other Status Codes |
Une erreur inattendue s’est produite. |
Sécurité
AADToken
Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.
Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Notes
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.
Authorization URL
est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST.
* L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent actuellement être traitées comme master clés du compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de serveur à serveur de Azure Maps API REST où cette clé peut être stockée en toute sécurité.
Type:
apiKey
In:
header
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.
Type:
apiKey
In:
header
Exemples
GetPointInPolygon
Sample Request
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
{
"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"
]
}
}
Définitions
Nom | Description |
---|---|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Json |
Format souhaité de la réponse. Seul le format |
Lat |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
Point |
Retourne true si point se trouve dans le polygone, false sinon |
Point |
Objet De synthèse de polygone point dans |
Result |
Point dans l’objet Résultat polygonal |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
JsonFormat
Format souhaité de la réponse. Seul le format json
est pris en charge.
Nom | Type | Description |
---|---|---|
json |
string |
LatLongPairAbbreviated
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ».
Nom | Type | Description |
---|---|---|
lat |
number |
Propriété Latitude |
lon |
number |
Longitude, propriété |
PointInPolygonResult
Retourne true si point se trouve dans le polygone, false sinon
Nom | Type | Description |
---|---|---|
result |
Point dans l’objet Résultat polygonal |
|
summary |
Objet De synthèse de polygone point dans |
PointInPolygonSummary
Objet De synthèse de polygone point dans
Nom | Type | Description |
---|---|---|
information |
string |
Traitement des informations |
sourcePoint |
Emplacement représenté sous la forme d’une latitude et d’une longitude utilisant des noms courts « lat » & « lon ». |
|
udid |
string |
ID de données unique (udid) pour le contenu chargé. Udid n’est pas applicable pour les opérations spatiales POST (défini sur null) |
Result
Point dans l’objet Résultat polygonal
Nom | Type | Description |
---|---|---|
intersectingGeometries |
string[] |
Tableau de géométries |
pointInPolygons |
boolean |
Point in Polygons, propriété |