Render - Get Map Tileset

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

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string (uri)

Le nom d’hôte du service Azure Maps. Utilisez https://atlas.microsoft.com pour le Azure cloud public. Pour cibler une géographie Azure Maps spécifique ou un nuage souverain, voir Azure Maps portée géographique.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

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’établissement de requêtes. Les tilesets prêts à l’emploi fournis par Azure Maps sont listés ci-dessous. Par exemple, microsoft.base.

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 depuis l’API de compte Azure Maps plan de gestion. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, voir Gérer l’authentification dans Azure Maps.

Réponses

Nom Type Description
200 OK

MapTileset

La demande a réussi.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

AadToken

Ce sont les flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès basé sur Azure par rôle, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès basés sur les rôles Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes ou sous-ressources de ressources Azure Maps. 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.

Note

  • 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 disposent d’URL d’autorisation uniques et de configurations d’identifiants Microsoft Entra ID.
  • 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

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: 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 Tileset Request

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom Description
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

MapTileset

Métadonnées d’un tileet 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’établissement de requêtes. Les tilesets prêts à l’emploi fournis par Azure Maps sont listés ci-dessous. Par exemple, microsoft.base.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

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 à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).

Nom Type Description
error

ErrorDetail

Objet d’erreur.

MapTileset

Métadonnées d’un tileet au format TileJSON.

Nom Type Description
attribution

string

Attribution de droits d’auteur à afficher sur la carte. Les implémentations PEUVENT décider de traiter cela comme du texte HTML ou littéral. Pour des raisons de sécurité, assurez-vous absolument que ce champ ne peut pas être utilisé comme vecteur pour le suivi XSS ou beacon.

bounds

number[] (float)

Étendue maximale des vignettes cartographiques 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[] (float)

Emplacement par défaut du tileset 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 tileset. 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 traiter cela comme du texte HTML ou littéral. Pour des raisons de sécurité, assurez-vous absolument que ce champ ne peut pas être utilisé comme vecteur pour le suivi XSS ou beacon.

maxzoom

integer (int32)

minimum: 0
maximum: 30

Niveau de zoom maximal.

minzoom

integer (int32)

minimum: 0
maximum: 30

Niveau de zoom minimal.

name

string

Nom décrivant le tileset. 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 mosaïque. Le profil global-mercator (aka Spherical Mercator) est supposé.

template

string

Modèle de moustache à utiliser pour mettre en forme les données à partir de grilles pour l’interaction.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

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

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Numéro de version de style semver.org pour les vignettes contenues dans le tileset. Lorsque les modifications entre les vignettes sont introduites, la version mineure doit être modifiée.

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’établissement de requêtes. Les tilesets prêts à l’emploi fournis par Azure Maps sont listés 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éorologique Azure Maps, voir Azure Maps couverture des services météorologiques. Pour plus d’informations sur les données radar, voir Services météorologiques en 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, voir Azure Maps couverture des services météorologiques. Pour plus d’informations sur les données satellites retournées, voir Services météorologiques en 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