Partager via

Render - Get Map State Tile

Service:
Maps
Version d'API:
1.0

Permet d’obtenir des vignettes d’état au format vectoriel généralement pour être intégrées dans le module cartes intérieures du contrôle de carte ou du Kit de développement logiciel (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.

Le contrôle de carte appelle cette API une fois que l’utilisateur active le style dynamique. Pour plus d’informations, consultez Niveaux de zoom et grille de vignettes.

GET https://atlas.microsoft.com/map/statetile?api-version=1.0&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

Paramètres URI

Nom Dans Obligatoire Type Description
api-version
 query True

string

Numéro de version de l’API Azure Maps.
statesetId
 query True

string

ID de l’ensemble d’états.
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.

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 vignette est retournée à partir d’un appel de vignette Obtenir l’état de la carte réussie

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

En-têtes

Content-Type: string
Other Status Codes

ErrorResponse

Une erreur inattendue s’est produite.

Media Types: "application/vnd.mapbox-vector-tile", "application/json"

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

Exemple de requête

GET https://atlas.microsoft.com/map/statetile?api-version=1.0&zoom=6&x=10&y=22&statesetId=[statesetId]

Exemple de réponse

Code d’état:
200 
Content-Type: application/vnd.mapbox-vector-tile
"{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

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.