Dataset - Create

Référence

Service:: Maps Creator

Version d'API:: 2.0

Utilisez pour créer un jeu de données.

L’API Create est une requête HTTP POST qui prend la conversionId valeur du package de dessin converti et retourne la datasetId propriété du jeu de données nouvellement créé. Pour plus d’informations, consultez Créer un jeu de données.

Vous pouvez utiliser cette demande dans un scénario tel que le chargement d’un package zip DWG pour un bâtiment, la conversion du package zip à l’aide du service de conversion Azure Maps et la création d’un jeu de données à partir du package zip converti. Le jeu de données créé peut être utilisé pour créer des tilesets à l’aide du service tileset Azure Maps et peut être interrogé via le service WFS Azure Maps.

Envoyer une demande de création

Pour créer votre jeu de données, vous allez utiliser une POST requête où le conversionId paramètre de requête est un ID qui représente le package zip DWG converti, le datasetId paramètre est l’ID d’un jeu de données créé précédemment à ajouter au jeu de données actuel et, éventuellement, le description paramètre de requête contient une description (si la description n’est pas fournie, une description par défaut est fournie).

L’API Create est une opération de longue durée.

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

Avec des paramètres facultatifs:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&description={description}

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.
conversionId	query	True	string	ID unique utilisé pour créer le jeu de données. Le `conversionId` doit avoir été obtenu à partir d’un appel réussi à l’API Convert du service de conversion et peut être fourni avec plusieurs paramètres de requête portant le même nom (si plusieurs sont fournis).
datasetId	query		string	ID du jeu de données à ajouter. Le jeu de données doit provenir d’un appel de création de jeu de données précédent qui correspond au datasetId
description	query		string	Description à donner au jeu de données.

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	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. En-têtes 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. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

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.

En-têtes

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.

En-têtes

Operation-Location: string

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

Exemples

Create dataset from a converted CAD file provided by conversionId

Exemple de requête

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

Exemple de réponse

Code d’état:: 200

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

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

Code d’état:: 202

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

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
LongRunningOperationResult	Modèle de réponse pour une API Long-Running Operations.
LroStatus	État status de la requête.

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.

Partager via

Dataset - Create

Envoyer une demande de création

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

subscription-key

SAS Token

Exemples

Create dataset from a converted CAD file provided by conversionId

Exemple de requête

Exemple de réponse

Définitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Ressources supplémentaires