Data - List Preview

Référence

Service:: Maps

API Version:: 1.0

La demande de liste permet à l’appelant d’extraire une liste de tout le contenu précédemment chargé à l’aide du chargement de données.
S’applique à : Niveau tarifaire S1.

Cette API permet à l’appelant d’extraire une liste de tout le contenu chargé précédemment à l’aide de l’API de chargement de données.

Notes

Retrait du service de données Azure Maps

Le service Data Azure Maps (v1 et v2) est désormais déconseillé et sera mis hors service le 16/09/2024. Pour éviter les interruptions de service, tous les appels au service Data devront être mis à jour pour utiliser le service Data Registry d’Azure Maps avant le 16/09/2024. Pour plus d'informations, consultez Guide pratique pour créer un registre de données.

Envoyer une demande de liste

Pour répertorier tout le contenu de vos données cartographiques, vous allez émettre une GET demande sans paramètres supplémentaires.

Réponse aux données de liste

L’API Liste de données retourne la liste complète de toutes les données au json format. La réponse contient les détails suivants pour chaque ressource de données :

udid : ID de données unique pour la ressource de données.

location : emplacement de la ressource de données. Exécutez un http GET à cet emplacement pour télécharger les données.

Voici un exemple de réponse retournant les udid et location de 3 ressources de données :

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?api-version=1.0

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
geography	path	True	string	Ce paramètre spécifie l’emplacement de la ressource Azure Maps Creator. Les valeurs valides sont us et eu.
api-version	query	True	string	Numéro de version de l’API Azure Maps. La version actuelle est 1.0
subscription-key	query		string	L’une des clés Azure Maps fournies par un compte Azure Map. Reportez-vous à cet article pour plus d’informations sur la gestion de l’authentification.

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	MapDataListResponse	Répertorier la demande de données terminée avec succès. Le corps de la réponse contient une liste de toutes les données précédemment chargées. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Demande incorrecte : un ou plusieurs paramètres ont été spécifiés de manière incorrecte ou s’excluent mutuellement.
401 Unauthorized	ODataErrorResponse	Accès refusé en raison d’une clé d’abonnement non valide ou d’un jeton du porteur Microsoft Entra ID non valide. Veillez à fournir une clé valide pour un abonnement Azure actif et une ressource Maps. Sinon, vérifiez l’en-tête WWW-Authenticate pour le code d’erreur et la description du jeton du porteur Microsoft Entra ID fourni. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Problèmes d’autorisation, de capacité ou d’authentification.
404 Not Found	ODataErrorResponse	Introuvable : la ressource demandée est introuvable, mais elle peut être à nouveau disponible à l’avenir.
500 Internal Server Error	ODataErrorResponse	Une erreur s’est produite lors du traitement de la demande. Veuillez réessayer plus tard.

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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Définitions

Nom	Description
MapDataDetailInfo	Informations détaillées pour les données.
MapDataListResponse	Modèle de réponse pour l’API Liste de données. Retourne une liste de toutes les données précédemment chargées.
ODataError	Cet objet est retourné lorsqu’une erreur se produit dans l’API Azure Maps.
ODataErrorResponse	Cet objet de réponse est retourné lorsqu’une erreur se produit dans l’API Azure Maps.

MapDataDetailInfo

Informations détaillées pour les données.

Nom	Type	Description
location	string	Emplacement des données. Exécutez un http `GET` à cet emplacement pour télécharger les données.
sizeInBytes	integer	Taille du contenu en octets.
udid	string	ID de données unique pour les données.
uploadStatus	string	Chargement actuel status du contenu.

MapDataListResponse

Modèle de réponse pour l’API Liste de données. Retourne une liste de toutes les données précédemment chargées.

Nom	Type	Description
mapDataList	MapDataDetailInfo[]	Liste de toutes les données précédemment chargées.

ODataError

Cet objet est retourné lorsqu’une erreur se produit dans l’API Azure Maps.

Nom	Type	Description
code	string	Code ODataError.
details	ODataError[]	Cet objet est retourné lorsqu’une erreur se produit dans l’API Azure Maps.
message	string	Le cas échéant, une description lisible de l’erreur.
target	string	Si disponible, la cible à l’origine de l’erreur.

ODataErrorResponse

Cet objet de réponse est retourné lorsqu’une erreur se produit dans l’API Azure Maps.

Nom	Type	Description
error	ODataError	Cet objet est retourné lorsqu’une erreur se produit dans l’API Azure Maps.

Share via

Data - List Preview

Envoyer une demande de liste

Réponse aux données de liste

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Notes

Scopes

subscription-key

SAS Token

Exemples

List all the previously uploaded data

Sample Request

Sample Response

Définitions

MapDataDetailInfo

MapDataListResponse

ODataError

ODataErrorResponse

Ressources supplémentaires