Render - Get Map Tile

Service:

Maps

Version d'API:

1.0

permet d’obtenir des vignettes de carte au format vectoriel ou raster généralement à intégrer à un nouveau contrôle de carte ou à un nouveau sdk.

Notes

Mettre hors service d’Azure Maps Render v1

Le service Azure Maps Render v1 est désormais obsolète et va être retiré le 17/9/26. Pour éviter les interruptions de service, tous les appels à l'API Render v1 doivent être mis à jour pour utiliser l'API Render v2 d'ici le 17/09/26.

Récupère les vignettes de carte au format vectoriel ou raster généralement à intégrer à un nouveau contrôle de carte ou à un nouveau KIT de développement logiciel (SDK). Par défaut, Azure utilise des vignettes de carte vectorielle pour son contrôle de carte web (voir Niveaux de zoom et grille de vignette)

Remarque : Les vignettes météo sont disponibles uniquement via l’API Obtenir la vignette de carte V2. Nous vous recommandons de commencer à utiliser la nouvelle API Get Map Tile V2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

Avec des paramètres facultatifs:

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
format	path	True	TileFormat	Format souhaité de la réponse. Les valeurs possibles sont png & pbf.
api-version	query	True	string	Numéro de version de l’API Azure Maps.
layer	query	True	MapTileLayer	Couche de carte demandée. Les valeurs possibles sont de base, hybrides, étiquettes et terra.
style	query	True	MapTileStyle	Style de carte à retourner. Les valeurs possibles sont main, sombre et shaded_relief.
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.
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 ou 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 disponibles. 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 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	object	Cette image est retournée à partir d’un appel de vignette Obtenir la carte 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é 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
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 lorsque vous créez un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, kits SDK Azure ou API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’approche des applications clientes confidentielles pour accéder Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

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
Dans: header

Exemples

Successful Tile Request

Exemple de requête

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Exemple de réponse

Code d’état:

200

Content-Type: image/png

"{file}"

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.
MapTileLayer	Couche de carte demandée. Les valeurs possibles sont basic, hybrid, labels et terra.
MapTileSize	Taille de la vignette de carte retournée en pixels.
MapTileStyle	Style de carte à retourner. Les valeurs possibles sont main, sombre et shaded_relief.
TileFormat	Format souhaité de la réponse. Les valeurs possibles sont png & pbf.

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)

MapTileLayer

Couche de carte demandée. Les valeurs possibles sont basic, hybrid, labels et terra.

Nom	Type	Description
basic	string	Retourne une vignette contenant toutes les caractéristiques de la carte, y compris les polygones, les bordures, les routes et les étiquettes.
hybrid	string	Retourne une vignette contenant des bordures, des routes et des étiquettes, et peut être superposée à d’autres vignettes (telles que des images satellites) pour produire des vignettes hybrides.
labels	string	Retourne une vignette des informations d’étiquette de la carte uniquement.
terra	string	Canevas de carte avec des vignettes en relief ombrées. Les niveaux de zoom 0 à 6 (inclus) sont pris en charge. Png est le seul TileFormat pris en charge et seul MapTileSize disponible est 512.

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.

MapTileStyle

Style de carte à retourner. Les valeurs possibles sont main, sombre et shaded_relief.

Nom	Type	Description
dark	string	Version gris foncé du style Azure Maps main. PNG est le seul TileFormat pris en charge.
main	string	style Azure Maps main
shaded_relief	string	Azure Maps main style complété par un relief ombré. Pris en charge par layer terra.

TileFormat

Format souhaité de la réponse. Les valeurs possibles sont png & pbf.

Nom	Type	Description
pbf	string	Graphique vectoriel au format pbf. Prend en charge les niveaux de zoom 0 à 22.
png	string	Image au format png. Prend en charge les niveaux de zoom 0 à 18.