Data - Upload

Référence

Service:: Maps

API Version:: 2.0

Permet de charger du contenu de données dans un compte Azure Maps.

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.

L’API Data Upload est une requête HTTP POST qui permet à l’appelant de charger du contenu de données vers le service Azure Maps. Vous pouvez utiliser cette API dans un scénario tel que le chargement d’une collection de limites géographiques au GeoJSONformat, pour une utilisation dans notre service de géofencing Azure Maps.

Important

En utilisant cette fonctionnalité, vous acceptez les conditions légales de la préversion. Pour plus d’informations, consultez la préversion des conditions supplémentaires .

Envoyer une demande de chargement

Pour charger votre contenu, vous utiliserez une POST requête. Le corps de la demande contient les données à charger. Le dataFormat paramètre de requête contient le format des données, le paramètre de dataSharingLevel requête peut contenir le niveau de partage des données. L’en-tête Content-Type est défini sur le type de contenu des données.

Par exemple, pour charger une collection de limites géographiques au GeoJSON format, définissez le corps de la demande sur le contenu de limite géographique. Définissez le dataFormat paramètre de requête sur geojson et définissez l’en-tête Content-Type sur l’un des types de médias suivants :

application/json
application/vnd.geo+json
application/octet-stream

Voici un exemple de corps de requête pour le chargement d’une limite géographique simple représentée sous la forme d’un cercle avec un point central et un rayon. L’exemple ci-dessous se trouve dans GeoJSON:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

L’API de chargement de données effectue une opération de longue durée.

Limites de chargement de données

N’oubliez pas qu’actuellement, chaque compte Azure Maps a une limite de stockage de données. Une fois la limite de stockage atteinte, tous les nouveaux appels d’API de chargement retournent une 409 Conflict réponse d’erreur HTTP. Vous pouvez toujours utiliser l’API De suppression de données pour supprimer du contenu ancien/inutilisé et créer de l’espace pour les nouveaux chargements.

POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&dataFormat={dataFormat}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&description={description}&dataFormat={dataFormat}

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.
dataFormat	query	True	DataFormat	Format de données du contenu en cours de chargement.
description	query		string	Description à donner au chargement.

En-tête de la demande

Media Types: "application/json", "application/octet-stream"

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.

Corps de la demande

Media Types: "application/json", "application/octet-stream"

Nom	Type	Description
UploadContent	object	Contenu à charger.

Réponses

Nom	Type	Description
200 OK	LongRunningOperationResult	L’opération est en cours d’exécution ou terminée. Si l’opération a réussi, utilisez l’en-tête Resource-Location pour obtenir le chemin d’accès au résultat. Headers Resource-Location: string
202 Accepted		Demande acceptée : la demande a été acceptée pour traitement. Utilisez l’URL dans l’en-tête Operation-Location pour obtenir status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	La limite de stockage des données est atteinte sur le compte Azure Maps. Vous pouvez toujours utiliser l’API De suppression de données pour supprimer du contenu ancien/inutilisé et créer de l’espace pour les nouveaux chargements.
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

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 Create un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, cli, 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

Upload GeoJSON data containing geometries that represent a collection of geofences

Sample Request

HTTP

POST https://us.atlas.microsoft.com/mapData?api-version=2.0&dataFormat=geojson

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.126986,
          47.639754
        ]
      },
      "properties": {
        "geometryId": "001",
        "radius": 500
      }
    }
  ]
}

Sample Response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Status code:: 409

{
  "error": {
    "code": "409 Conflict",
    "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
  }
}

Définitions

Nom	Description
DataFormat	Format de données du contenu chargé.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
LongRunningOperationResult	Modèle de réponse pour une API Long-Running Operations.
LroStatus	État status de la requête.

DataFormat

Format de données du contenu chargé.

Nom	Type	Description
dwgzippackage	string	Package ZIP contenant un fichier DWG.
geojson	string	GeoJSON est un format d’échange de données géospatiales basé sur JSON.
zip	string	Format de données compressées.

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.

LongRunningOperationResult

Modèle de réponse pour une API Long-Running Operations.

Nom	Type	Description
created	string	Horodatage créé.
error	ErrorDetail	Détail de l’erreur.
operationId	string	ID de cette opération de longue durée.
status	LroStatus	État status de la requête.
warning	ErrorDetail	Détail de l’erreur.

LroStatus

État status de la requête.

Nom	Type	Description
Failed	string	La requête présente un ou plusieurs échecs.
NotStarted	string	Le traitement de la demande n’a pas encore commencé.
Running	string	Le traitement de la demande a commencé.
Succeeded	string	La demande s’est terminée avec succès.

Share via

Data - Upload

Envoyer une demande de chargement

Limites de chargement de données

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

AADToken

Notes

Scopes

subscription-key

SAS Token

Exemples

Upload GeoJSON data containing geometries that represent a collection of geofences

Sample Request

Sample Response

Définitions

DataFormat

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Ressources supplémentaires