Partager via


Render - Get Map Tile

Permet de demander des vignettes cartographiques au format vectoriel ou raster.

L’API Get Map Tiles permet aux utilisateurs de demander des tuiles de carte dans des formats vectoriels ou raster, généralement pour l’intégration dans un contrôle de carte ou un SDK. Les types de vignettes pris en charge incluent les vignettes de route Azure Maps et les vignettes Radar météo en temps réel. Par défaut, le Kit de développement logiciel (SDK) web Azure Maps utilise des tuiles vectorielles pour le rendu de son contrôle de carte web.

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
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 2024-04-01.

tilesetId
query True

TilesetID

Un tileset est une collection de données raster ou vectorielles divisées en une grille uniforme de vignettes carrées aux niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’établissement de requêtes. Les vignettes prêtes à l’emploi fournies par Azure Maps sont répertoriées 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 la grille de vignettes.

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 la grille de vignettes.

zoom
query True

integer (int32)

Niveau de zoom pour la vignette souhaitée.

Pour plus d’informations, consultez niveaux de zoom et la grille de vignettes.

language
query

string

Langue dans laquelle les résultats de recherche doivent être retournés. Doit être l’une des balises de langage 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é au format date-heure standard (par exemple, 2019-11-14T16:03:00-08:00), tel que défini par ISO 8601. Ce paramètre est pris en charge uniquement lorsque le paramètre tilesetId est défini sur l’une des valeurs ci-dessous.

  • microsoft.weather.infrarouge.main : Nous fournissons des vignettes jusqu’à 3 heures dans le passé. Les vignettes sont disponibles dans des intervalles de 10 minutes. Nous arrondissons la valeur timeStamp à l’intervalle de temps de 10 minutes le plus proche.
  • microsoft.weather.radar.main : Nous fournissons des vignettes jusqu’à 1,5 heures dans le passé et jusqu’à 2 heures à l’avenir. Les vignettes sont disponibles à intervalles de 5 minutes. Nous arrondissons la valeur timeStamp à l’intervalle de temps de 5 minutes le plus proche.
view
query

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région 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/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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, les images et d’autres données et le contenu tiers que 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 afficher les vues disponibles.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-id

string

Indique le compte destiné à être utilisé avec le modèle de sécurité Microsoft Entra ID. Cet ID unique pour le compte Azure Maps peut être obtenu à partir de l’API de compte du plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps.

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 Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, 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 Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.

Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Remarques

  • Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.

La 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 de l'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 la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

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 provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le 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 être traitées comme des clés principales pour le compte pour lequel elles sont émises.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès 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, CLI, azure SDK 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 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, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Successful Tile Request

Exemple de requête

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

Exemple de réponse

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 certain pays/région 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/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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, les images et d’autres données et le contenu tiers que 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 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 vignettes carrées aux niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’établissement de requêtes. Les vignettes prêtes à l’emploi fournies par Azure Maps sont répertoriées 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émentaire.

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.

LocalizedMapView

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région 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/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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, les images et d’autres données et le contenu tiers que 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 afficher les vues disponibles.

Valeur Description
AE

Émirats Arabes Unis (affichage arabe)

AR

Argentine (affichage argentin)

BH

Bahreïn (affichage arabe)

IN

Inde (affichage indien)

IQ

Irak (affichage arabe)

JO

Jordanie (affichage arabe)

KW

Koweït (affichage arabe)

LB

Liban (affichage arabe)

MA

Maroc (affichage marocain)

OM

Oman (affichage arabe)

PK

Pakistan (affichage pakistanais)

PS

Autorité palestinienne (affichage arabe)

QA

Qatar (affichage arabe)

SA

Arabie Saoudite (affichage arabe)

SY

Syrie (affichage arabe)

US

États-Unis d’Amérique

YE

Yémen (affichage arabe)

Auto

Retournez les données cartographiques en fonction de l’adresse IP de la requête.

Unified

Affichage unifié (Autres)

MapTileSize

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

Valeur Description
256

Retournez une vignette de 256 par 256 pixels.

512

Retournez une vignette de 512 par 512 pixels.

TilesetID

Un tileset est une collection de données raster ou vectorielles divisées en une grille uniforme de vignettes carrées aux niveaux de zoom prédéfinis. Chaque ensemble de vignettes a un tilesetId à utiliser lors de l’établissement de requêtes. Les vignettes prêtes à l’emploi fournies par Azure Maps sont répertoriées ci-dessous. Par exemple, microsoft.base.

Valeur Description
microsoft.base

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 : vecteur (pbf).

microsoft.base.labels

Affiche des étiquettes pour les routes, les caractéristiques naturelles et artificielles d’une vignette vectorielle.

Prend en charge les niveaux de zoom 0 à 22. Format : vecteur (pbf).

microsoft.base.hybrid

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 : vecteur (pbf).

microsoft.terra.main

Relief ombré et couches terra.

Prend en charge les niveaux de zoom 0 à 6. Format : raster (png).

microsoft.base.road

Toutes les couches avec notre style principal.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.base.darkgrey

Toutes les couches avec notre style gris foncé.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.base.labels.road

Étiqueter les données dans notre style principal.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.base.labels.darkgrey

Étiqueter les données dans notre style gris foncé.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.base.hybrid.road

Données de route, de limite et d’étiquette dans notre style principal.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.base.hybrid.darkgrey

Données de route, de limite et d’étiquette dans notre style gris foncé.

Prend en charge les niveaux de zoom 0 à 22. Format : raster (png).

microsoft.imagery

Combinaison d’images satellites ou aériennes. Disponible uniquement dans la référence S1 et G2 tarifaire.

Prend en charge les niveaux de zoom 1 à 19. Format : raster (png).

microsoft.weather.radar.main

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éo 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).

microsoft.weather.infrared.main

Mosaïques infrarouges météorologiques. Les dernières images satellite infrarouges montrent les nuages par leur température. Pour plus d’informations, consultez Couverture des services météo Azure Maps. Pour plus d’informations sur les données satellite renvoyées, consultez Services météo dans Azure Maps.

Prend en charge les niveaux de zoom 0 à 15. Format : raster (png).

microsoft.traffic.absolute

vignettes de trafic absolues dans le vecteur

microsoft.traffic.absolute.main

vignettes de trafic absolues en raster dans notre style principal.

microsoft.traffic.relative

vignettes de trafic relative dans le vecteur

microsoft.traffic.relative.main

vignettes de trafic relative en raster dans notre style principal.

microsoft.traffic.relative.dark

vignettes de trafic relative en raster dans notre style sombre.

microsoft.traffic.delay

vignettes de trafic dans le vecteur

microsoft.traffic.delay.main

vignettes de trafic en raster dans notre style principal

microsoft.traffic.reduced.main

réduction des vignettes de trafic en raster dans notre style principal

microsoft.traffic.incident

vignettes d’incident dans le vecteur