Spatial - Get Buffer
Utilisez pour obtenir un FeatureCollection
où chaque fonctionnalité est une mémoire tampon autour de la fonctionnalité indexée correspondante de l’entrée.
L’API Get Buffer
est une requête HTTP GET
qui retourne un FeatureCollection
où chaque fonctionnalité est une mémoire tampon autour de la fonctionnalité indexée correspondante de l’entrée. La mémoire tampon peut se trouver à l’extérieur ou à l’intérieur de la fonctionnalité fournie, en fonction de la distance fournie dans l’entrée. L’entrée FeatureCollection doit contenir une seule distance par fonctionnalité ou, si une seule distance est fournie, cette distance est appliquée à chaque fonctionnalité de la collection. La mémoire tampon positive (ou négative) d’une géométrie est définie comme la somme minkowski (ou la différence) de la géométrie avec un cercle de rayon égal à la valeur absolue de la distance de la mémoire tampon. L’API de mémoire tampon retourne toujours un résultat polygonal. La mémoire tampon de distance négative ou nulle des lignes et des points est toujours un polygone vide. Les fonctionnalités d’entrée sont fournies par un fichier GeoJSON qui est chargé à l’aide de l’API du registre de données et référencé par un udid unique. Le fichier GeoJSON peut contenir une collection de Points, MultiPoint, Polygon, MultiPolygon, LineString et MultiLineString. GeometryCollection sera ignoré s’il est fourni.
Pour tester cette API, vous pouvez charger les exemples de données à partir d’exemples d’API post-mémoire tampon (corps de la requête sans tableau de distances) à l’aide du service de registre de données et remplacer dans {udid}
l’exemple de requête suivant 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/buffer/json?api-version=2022-08-01&udid={udid}&distances={distances}
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 nous (USA Est, USA Centre-Ouest, USA Ouest 2) et eu (Europe Nord, Europe Ouest). Ce paramètre est obligatoire lorsqu’un |
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
distances
|
query | True |
string |
Liste des distances (une par fonctionnalité ou une pour toutes les caractéristiques), délimitées par des points-virgules. Par exemple, 12.34 ;-56.78. La distance positive génère une mémoire tampon en dehors de la fonctionnalité, tandis que la distance négative génère une mémoire tampon à l’intérieur de la fonctionnalité. Si la distance négative est supérieure à la géométrie elle-même, un polygone vide est retourné. |
udid
|
query | True |
string |
ID unique utilisé lors de la création d’un registre de données pour charger un objet FeatureCollection GeoJSON 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 le compte 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 ressource 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.
est Authorization URL
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, kits 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 qui est 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, celles-ci peuvent actuellement être traitées comme des clés master du compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès 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 Répertorier les SAP 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 précis à l’expiration, au taux et à la ou les régions d’utilisation du 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, nous vous recommandons 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 SAS.
Type:
apiKey
In:
header
Exemples
GetBuffer
Sample Request
GET https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&distances=176.3
Sample Response
{
"summary": {
"udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"information": "1 feature processed in user data"
},
"result": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": "ExampleId",
"bufferDist": 176.3
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-111.92483859605078,
33.5362475
],
[
-111.92487510409389,
33.53587682761772
],
[
-111.92498322523961,
33.535520399967204
],
[
-111.92515880445296,
33.535191914363196
],
[
-111.92539509432322,
33.53490399432323
],
[
-111.92568301436319,
33.53466770445297
],
[
-111.9260114999672,
33.53449212523963
],
[
-111.9263679276177,
33.5343840040939
],
[
-111.9267386,
33.534347496050785
],
[
-111.92710927238228,
33.5343840040939
],
[
-111.92746570003278,
33.53449212523963
],
[
-111.9277941856368,
33.53466770445297
],
[
-111.92808210567676,
33.53490399432323
],
[
-111.92831839554702,
33.535191914363196
],
[
-111.92849397476037,
33.535520399967204
],
[
-111.9286020959061,
33.53587682761772
],
[
-111.92863860394921,
33.5362475
],
[
-111.9286020959061,
33.53661817238228
],
[
-111.92849397476037,
33.5369746000328
],
[
-111.92831839554702,
33.53730308563681
],
[
-111.92808210567676,
33.537591005676774
],
[
-111.9277941856368,
33.53782729554703
],
[
-111.92746570003278,
33.53800287476037
],
[
-111.92710927238228,
33.5381109959061
],
[
-111.9267386,
33.53814750394922
],
[
-111.9263679276177,
33.5381109959061
],
[
-111.9260114999672,
33.53800287476037
],
[
-111.92568301436319,
33.53782729554703
],
[
-111.92539509432322,
33.537591005676774
],
[
-111.92515880445296,
33.53730308563681
],
[
-111.92498322523961,
33.5369746000328
],
[
-111.92487510409389,
33.53661817238228
],
[
-111.92483859605078,
33.5362475
]
]
]
}
}
]
}
}
Définitions
Nom | Description |
---|---|
Buffer |
Cet objet est retourné à partir d’un appel de mémoire tampon spatiale réussi. |
Buffer |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Geo |
Type d’objet valide |
Geo |
Type d’objet valide |
Geo |
Objet geometry valide |
Geo |
Type d’objet valide |
Geo |
Type geometry valide |
Geo |
Type geometry valide |
Geo |
Type geometry valide |
Geo |
Type d’objet valide |
Geo |
Type geometry valide |
Geo |
Type geometry valide |
Json |
Format souhaité de la réponse. Seul le format |
BufferResult
Cet objet est retourné à partir d’un appel de mémoire tampon spatiale réussi.
Nom | Type | Description |
---|---|---|
result |
FeatureCollection des mémoires tampons pour l’entrée. |
|
summary |
BufferSummary
Nom | Type | Description |
---|---|---|
information |
string |
Informations sur ce qui s’est passé pendant l’appel. |
udid |
string |
L’udid pour les données utilisateur s’il en existe une |
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 error. |
GeoJsonFeature
Type d’objet valide GeoJSON Feature
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
featureType |
string |
Type de la fonctionnalité. La valeur dépend du modèle de données dont fait partie la fonctionnalité actuelle. Certains modèles de données peuvent avoir une valeur vide. |
geometry | GeoJsonGeometry: |
Objet geometry valide |
id |
string |
Identificateur de la fonctionnalité. |
type |
string:
Feature |
Spécifie le type |
GeoJsonFeatureCollection
Type d’objet valide GeoJSON FeatureCollection
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
features |
Contient une liste d’objets valides |
|
type |
string:
Feature |
Spécifie le type |
GeoJsonGeometry
Objet geometry valide GeoJSON
. Le type doit être l’un des sept types géométriques GeoJSON valides : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon et GeometryCollection. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
type |
Geo |
Spécifie le type |
GeoJsonGeometryCollection
Type d’objet valide GeoJSON GeometryCollection
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contient une liste d’objets géométriques valides |
type |
string:
Geometry |
Spécifie le type |
GeoJsonLineString
Type geometry valide GeoJSON LineString
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Coordonnées de la |
type |
string:
Line |
Spécifie le type |
GeoJsonMultiLineString
Type geometry valide GeoJSON MultiLineString
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Coordonnées de la |
type |
string:
Multi |
Spécifie le type |
GeoJsonMultiPoint
Type geometry valide GeoJSON MultiPoint
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Coordonnées de la |
type |
string:
Multi |
Spécifie le type |
GeoJsonMultiPolygon
Type d’objet valide GeoJSON MultiPolygon
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Contient une liste d’objets valides |
type |
string:
Multi |
Spécifie le type |
GeoJsonPoint
Type geometry valide GeoJSON Point
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Un |
type |
string:
Point |
Spécifie le type |
GeoJsonPolygon
Type geometry valide GeoJSON Polygon
. Pour plus d’informations, consultez RFC 7946 .
Nom | Type | Description |
---|---|---|
coordinates |
number[] |
Coordonnées du |
type |
string:
Polygon |
Spécifie le type |
JsonFormat
Format souhaité de la réponse. Seul le format json
est pris en charge.
Nom | Type | Description |
---|---|---|
json |
string |