Render - Get Map Tile

Service:

Maps

Version d'API:

2024-04-01

Utilisez pour demander des vignettes de mappage au format vectoriel ou raster.

L’API Get Map Tiles dans une requête HTTP GET qui permet aux utilisateurs de demander des vignettes de carte dans des formats vectoriels ou raster généralement à intégrer à un contrôle de carte ou à un kit SDK. Voici quelques exemples de vignettes qui peuvent être demandées : les vignettes routières Azure Maps, les vignettes Radar météo en temps réel ou les vignettes de carte créées à l’aide d’Azure Maps Creator. Par défaut, Azure Maps utilise des vignettes vectorielles pour son contrôle de carte web (Kit de développement logiciel (SDK web) et le Kit de développement logiciel (SDK) Android.

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

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

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.
x	query	True	integer int32	Coordonnée X de la vignette sur la grille de zoom. La valeur doit se trouver dans la plage [0, 2zoom -1]. Pour plus d’informations, consultez Niveaux de zoom et Grille de mosaïques .
y	query	True	integer int32	Coordonnée Y de la vignette sur la grille de zoom. La valeur doit se trouver dans la plage [0, 2zoom -1]. Pour plus d’informations, consultez Niveaux de zoom et Grille de mosaïques .
zoom	query	True	integer int32	Niveau de zoom de la vignette souhaitée. Pour plus d’informations, consultez Niveaux de zoom et Grille de mosaïques .
language	query		string	Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, sans respect de la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez Langues prises en charge .
tileSize	query		MapTileSize	Taille de la vignette de carte retournée en pixels.
timeStamp	query		string date-time	Date et heure souhaitées de la vignette demandée. Ce paramètre doit être spécifié dans le format date-heure standard (par exemple, 2019-11-14T16:03:00-08:00), tel que défini par ISO 8601. Ce paramètre n’est pris en charge que lorsque le paramètre tilesetId est défini sur l’une des valeurs ci-dessous. microsoft.weather.infrared.main : nous fournissons des vignettes jusqu’à 3 heures dans le passé. Les vignettes sont disponibles par intervalles de 10 minutes. Nous arrondissons la valeur timeStamp à la période de 10 minutes la plus proche. microsoft.weather.radar.main : nous fournissons des vignettes jusqu’à 1,5 heure dans le passé et jusqu’à 2 heures à l’avenir. Les vignettes sont disponibles par intervalles de 5 minutes. Nous arrondissons la valeur timeStamp à la période de 5 minutes la plus proche.
view	query		LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes correctes pour un pays/région spécifique pour les régions géopolitiquement contestées. Les différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à l’affichage requis par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et contenus tiers auxquels vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Vues prises en charge pour plus d’informations et pour voir les vues disponibles.

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	object	Vignette retournée à partir d’un appel d’API réussi. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" En-têtes Content-Type: string
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

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
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 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 Tile Request

Sample request

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Sample response

Status code:

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

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
LocalizedMapView	Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.
MapTileSize	Taille de la vignette de carte retournée en pixels.
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 tileset a un tilesetId à utiliser lors de l’envoi de requêtes. Les tilesetId pour les tilesets créés à l’aide d’Azure Maps Creator sont générés via l’API De création de tileset. 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 error.

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un pays/une région spécifique pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/la région que votre application servira. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps sont mis à disposition. Exemple : view=IN.

Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.

Nom	Type	Description
AE	string	Émirats Arabes Unis (affichage arabe)
AR	string	Argentine (affichage argentin)
Auto	string	Retourne les données cartographiques correspondant à l’adresse IP de la requête.
BH	string	Bahreïn (affichage arabe)
IN	string	Inde (affichage indien)
IQ	string	Irak (affichage arabe)
JO	string	Jordanie (affichage arabe)
KW	string	Koweït (affichage arabe)
LB	string	Liban (affichage arabe)
MA	string	Maroc (affichage marocain)
OM	string	Oman (affichage arabe)
PK	string	Pakistan (affichage pakistanais)
PS	string	Autorité palestinienne (affichage arabe)
QA	string	Qatar (affichage arabe)
SA	string	Arabie Saoudite (affichage arabe)
SY	string	Syrie (affichage arabe)
Unified	string	Affichage unifié (Autres)
YE	string	Yémen (affichage arabe)

MapTileSize

Taille de la vignette de carte retournée en pixels.

Nom	Type	Description
256	string	Retourne une vignette de 256 x 256 pixels.
512	string	Retourne une vignette de 512 x 512 pixels.

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 tileset a un tilesetId à utiliser lors de l’envoi de requêtes. Les tilesetId pour les tilesets créés à l’aide d’Azure Maps Creator sont générés via l’API De création de tileset. 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 de route, de limites et d’é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 de routes, de limites et d’é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	Étiqueter 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	Toutes les couches 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 de tarification 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éduites en raster dans notre style principal
microsoft.traffic.relative	string	vignettes de trafic relatif dans vector
microsoft.traffic.relative.dark	string	vignettes de trafic relatives en raster dans notre style sombre.
microsoft.traffic.relative.main	string	vignettes de trafic relatives 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 incluant des 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éo dans Azure Maps. Prend en charge les niveaux de zoom 0 à 15. Format : raster (png).