Render - Get Map Tileset

Référence

Service:: Maps

Version d'API:: 2024-04-01

Permet d’obtenir les métadonnées d’un ensemble de vignettes.

L’API Get Map Tileset permet aux utilisateurs de demander des métadonnées pour un ensemble de vignettes.

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Numéro de version de l’API Azure Maps. La version actuelle est 01/04/2024.
tilesetId	query	True	TilesetID	Un tileset est une collection de données raster ou vectorielles divisées en une grille uniforme de mosaïques carrées à des niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’envoi de requêtes. Les tilesetId pour les ensembles de vignettes créés à l’aide d’Azure Maps Creator sont générés via l’API Création de tilesets. Les ensembles de vignettes prêts à l’emploi fournis par Azure Maps sont répertoriés ci-dessous. Par exemple, microsoft.base.

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é de l’ID Microsoft Entra. 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 la sécurité des ID Microsoft Entra dans Azure Maps, consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	MapTileset	Ok
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux OAuth Microsoft Entra 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 aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Ou sous-ressources Azure Maps. 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 aux API REST Azure Maps.

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 à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les 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 la plateforme d’identités Microsoft, consultez Vue d’ensemble de la plateforme d’identités Microsoft.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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 le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les 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 principales du compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès de serveur à serveur des API REST Azure Maps, où cette clé peut être stockée en toute sécurité.

Type: apiKey
Dans: 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 le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les 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
Dans: header

Exemples

Successful Tileset Request

Exemple de requête

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Exemple de réponse

Code d’état:: 200

{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
MapTileset	Métadonnées d’un ensemble de vignettes au format TileJSON.
TilesetID	Un tileset est une collection de données raster ou vectorielles divisées en une grille uniforme de mosaïques carrées à des niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’envoi de requêtes. Les tilesetId pour les ensembles de vignettes créés à l’aide d’Azure Maps Creator sont générés via l’API Création de tilesets. Les ensembles de vignettes prêts à l’emploi fournis par Azure Maps sont répertoriés ci-dessous. Par exemple, microsoft.base.

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	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

MapTileset

Métadonnées d’un ensemble de vignettes au format TileJSON.

Nom	Type	Description
attribution	string	Attribution de droits d’auteur à afficher sur la carte. Les implémentations PEUVENT décider de le traiter comme du HTML ou du texte littéral. Pour des raisons de sécurité, assurez-vous absolument que ce champ ne peut pas être utilisé comme vecteur pour XSS ou le suivi des balises.
bounds	number[]	Étendue maximale des vignettes de carte disponibles. Les limites DOIVENT définir une zone couverte par tous les niveaux de zoom. Les limites sont représentées dans les valeurs de latitude et de longitude WGS :84, dans l’ordre gauche, inférieur, droit, supérieur. Les valeurs peuvent être des entiers ou des nombres à virgule flottante.
center	number[]	Emplacement par défaut du mosaïque sous la forme [longitude, latitude, zoom]. Le niveau de zoom DOIT être compris entre minzoom et maxzoom. Les implémentations peuvent utiliser cette valeur pour définir l’emplacement par défaut.
data	string[]	Tableau de fichiers de données au format GeoJSON.
description	string	Description textuelle du mosaïque. La description peut contenir n’importe quel caractère juridique. Les implémentations NE DOIVENT PAS interpréter la description comme html.
grids	string[]	Tableau de points de terminaison d’interactivité.
legend	string	Légende à afficher avec la carte. Les implémentations PEUVENT décider de le traiter comme du HTML ou du texte littéral. Pour des raisons de sécurité, assurez-vous absolument que ce champ ne peut pas être utilisé comme vecteur pour XSS ou le suivi des balises.
maxzoom	integer	Niveau de zoom maximal.
minzoom	integer	Niveau de zoom minimal.
name	string	Nom décrivant le mosaïque. Le nom peut contenir n’importe quel caractère légal. Les implémentations NE DOIVENT PAS interpréter le nom comme html.
scheme	string	Valeur par défaut : « xyz ». « xyz » ou « tms ». Influence la direction y des coordonnées de vignette. Le profil global-mercator (aka Spherical Mercator) est supposé.
template	string	Modèle de moustache à utiliser pour mettre en forme les données des grilles pour l’interaction.
tilejson	string	Décrit la version de la spécification TileJSON implémentée par cet objet JSON.
tiles	string[]	Tableau de points de terminaison de vignette. Si plusieurs points de terminaison sont spécifiés, les clients peuvent utiliser n’importe quelle combinaison de points de terminaison. Tous les points de terminaison DOIVENT retourner le même contenu pour la même URL. Le tableau DOIT contenir au moins un point de terminaison.
version	string	Un semver.org numéro de version de style pour les vignettes contenues dans le mosaïque. Lorsque des modifications entre les vignettes sont introduites, la version mineure DOIT changer.

TilesetID

Un tileset est une collection de données raster ou vectorielles divisées en une grille uniforme de mosaïques carrées à des niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’envoi de requêtes. Les tilesetId pour les ensembles de vignettes créés à l’aide d’Azure Maps Creator sont générés via l’API Création de tilesets. Les ensembles de vignettes prêts à l’emploi fournis par Azure Maps sont répertoriés ci-dessous. Par exemple, microsoft.base.

Nom	Type	Description
microsoft.base	string	Une carte de base est une carte standard qui affiche les routes, les caractéristiques naturelles et artificielles, ainsi que les étiquettes de ces caractéristiques dans une vignette vectorielle. Prend en charge les niveaux de zoom 0 à 22. Format : vector (pbf).
microsoft.base.darkgrey	string	Toutes les couches avec notre style gris foncé. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.base.hybrid	string	Affiche les données de route, de limite et d’étiquette dans une vignette vectorielle. Prend en charge les niveaux de zoom 0 à 22. Format : vector (pbf).
microsoft.base.hybrid.darkgrey	string	Données routières, limites et étiquettes dans notre style gris foncé. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.base.hybrid.road	string	Données routières, limites et étiquettes dans notre style principal. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.base.labels	string	Affiche des étiquettes pour les routes, les caractéristiques naturelles et artificielles dans une vignette vectorielle. Prend en charge les niveaux de zoom 0 à 22. Format : vector (pbf).
microsoft.base.labels.darkgrey	string	Étiquetez les données dans notre style gris foncé. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.base.labels.road	string	Étiqueter les données dans notre style principal. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.base.road	string	Tous les calques avec notre style principal. Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).
microsoft.imagery	string	Combinaison d’images satellite et aérienne. Disponible uniquement dans la référence SKU tarifaire S1. Prend en charge les niveaux de zoom 1 à 19. Format : raster (jpeg).
microsoft.terra.main	string	Relief ombré et couches terra. Prend en charge les niveaux de zoom 0 à 6. Format : raster (png).
microsoft.traffic.absolute	string	vignettes de trafic absolu dans vector
microsoft.traffic.absolute.main	string	vignettes de trafic absolues en raster dans notre style principal.
microsoft.traffic.delay	string	vignettes de trafic dans vector
microsoft.traffic.delay.main	string	vignettes de trafic en raster dans notre style principal
microsoft.traffic.incident	string	vignettes d’incident dans vector
microsoft.traffic.reduced.main	string	vignettes de trafic réduit en raster dans notre style principal
microsoft.traffic.relative	string	vignettes de trafic relatif dans vector
microsoft.traffic.relative.dark	string	vignettes relatives du trafic en raster dans notre style sombre.
microsoft.traffic.relative.main	string	vignettes relatives du trafic en raster dans notre style principal.
microsoft.weather.infrared.main	string	Mosaïques infrarouges météo. Les dernières images satellite infrarouges montrent les nuages par leur température. Pour plus d’informations, consultez Couverture des services météorologiques Azure Maps. Pour plus d’informations sur les données satellite retournées, consultez Services météorologiques dans Azure Maps. Prend en charge les niveaux de zoom 0 à 15. Format : raster (png).
microsoft.weather.radar.main	string	Vignettes radar météo. Dernières images radar météorologiques, y compris les zones de pluie, de neige, de glace et de conditions mixtes. Pour plus d’informations sur la couverture du service météo Azure Maps, consultez Couverture des services météorologiques Azure Maps. Pour plus d’informations sur les données radar, consultez Services météorologiques dans Azure Maps. Prend en charge les niveaux de zoom 0 à 15. Format : raster (png).

Partager via