Render - Get Map Tile
permet d’obtenir des vignettes cartographiques au format vectoriel ou raster généralement pour être intégrées à un nouveau contrôle de carte ou au SDK.
Remarque
Retrait du service Azure Maps Render v1
Le service Azure Maps Render v1 est désormais déconseillé et sera mis hors service le 17/09/26. Pour éviter les interruptions de service, tous les appels à l’API Render v1 doivent être mis à jour pour utiliser la dernière version de l’API Render d’après le 17/9/17/26.
Récupère les vignettes de carte au format vectoriel ou raster généralement à intégrer dans un nouveau contrôle de carte ou un kit 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 vignettes)
Remarque : Les tuiles météo ne sont pas disponibles à l’aide de l’API Get Map Tile v1.0. Nous vous recommandons d’utiliser la dernière version de l’API Get Map Tile .
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}
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 |
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 |
Couche de mappage demandée. Les valeurs possibles sont de base, hybrides, étiquettes et terra. |
|
|
style
|
query | True |
Style de carte à renvoyer. Les valeurs possibles sont principales, sombres 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, 2 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, 2 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. |
|
|
tile
|
query |
Taille de la vignette de carte retournée en pixels. |
||
|
view
|
query |
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 |
Cette image est retournée à partir d’un appel de vignette Get Map réussie Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" En-têtes Content-Type: string |
| Other Status Codes |
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-idpour 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.
- 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 provisionnée lorsque vous créer un compte Azure Maps dans le portail Azure ou à l’aide de PowerShell, CLI, sdk Azure ou API REST.
Avec cette clé, toute application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé principale dans le compte dans lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser les applications clientes confidentielles approche permettant d’accéder aux API REST Azure Maps 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 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/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22
Exemple de réponse
Content-Type: image/png
"{file}"
Définitions
| Nom | Description |
|---|---|
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Localized |
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. |
|
Map |
Couche de mappage demandée. Les valeurs possibles sont de base, hybrides, étiquettes et terra. |
|
Map |
Taille de la vignette de carte retournée en pixels. |
|
Map |
Style de carte à renvoyer. Les valeurs possibles sont principales, sombres et shaded_relief. |
|
Tile |
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émentaire. |
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 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 (vue arabe) |
| AR |
Argentine (vue argentine) |
| BH |
Bahreïn (vue arabe) |
| IN |
Inde (Vue indienne) |
| IQ |
Irak (vue arabe) |
| JO |
Jordanie (vue arabe) |
| KW |
Koweït (vue arabe) |
| LB |
Liban (vue arabe) |
| MA |
Maroc (vue marocaine) |
| OM |
Oman (vue arabe) |
| PK |
Pakistan (vue pakistanaise) |
| PS |
Autorité palestinienne (vue arabe) |
| QA |
Qatar (vue arabe) |
| SA |
Arabie saoudite (vue arabe) |
| SY |
Syrie (vue arabe) |
| US |
États-Unis d’Amérique |
| YE |
Yémen (vue arabe) |
| Auto |
Retournez les données cartographiques en fonction de l’adresse IP de la requête. |
| Unified |
Affichage unifié (autres) |
MapTileLayer
Couche de mappage demandée. Les valeurs possibles sont de base, hybrides, étiquettes et terra.
| Valeur | Description |
|---|---|
| basic |
Retourne une vignette contenant toutes les fonctionnalités cartographiques, notamment les polygones, les bordures, les routes et les étiquettes. |
| hybrid |
Retourne une vignette contenant des bordures, des routes et des étiquettes, et peut être superposée sur d’autres vignettes (telles que l’imagerie satellite) pour produire des vignettes hybrides. |
| labels |
Retourne une vignette des informations d’étiquette de la carte uniquement. |
| terra |
Mapper le canevas avec des mosaïques de 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.
| Valeur | Description |
|---|---|
| 256 |
Retournez une vignette de 256 par 256 pixels. |
| 512 |
Retournez une vignette de 512 par 512 pixels. |
MapTileStyle
Style de carte à renvoyer. Les valeurs possibles sont principales, sombres et shaded_relief.
| Valeur | Description |
|---|---|
| main |
Style principal d’Azure Maps |
| dark |
Version gris foncé du style principal Azure Maps. PNG est le seul TileFormat pris en charge. |
| shaded_relief |
Style principal Azure Maps terminé avec relief ombré. Pris en charge par layer terra. |
TileFormat
Format souhaité de la réponse. Les valeurs possibles sont png & pbf.
| Valeur | Description |
|---|---|
| png |
Image au format png. Prend en charge les niveaux de zoom 0 à 18. |
| pbf |
Graphique vectoriel au format pbf. Prend en charge les niveaux de zoom 0 à 22. |