Routeset - Create

Service:

Maps Creator

Version d'API:

2023-03-01-preview

Utilisez pour créer un ensemble de routes.

L’API Create est une requête HTTP POST qui permet à l’appelant de créer un ensemble de routes à partir d’un jeu de données. L’ensemble de routes est une structure de données utilisée par le service Wayfinding Azure Maps pour découvrir les chemins d’accès les plus courts au sein d’une installation.

L’API Créer un ensemble de routes est une opération de longue durée.

Creator permet de développer des applications basées sur vos données de carte d’intérieur privées à l’aide de Azure Maps’API et de kits SDK. Consultez l’article Creator pour les cartes d’intérieur pour une introduction aux concepts et outils Azure Maps Creator.

Envoyer une demande de création

Pour créer un ensemble de routes, effectuez une POST requête avec un corps vide. Le jeu de données étant utilisé comme source des données de l’ensemble de routes, le paramètre de datasetId requête doit être inclus.

POST https://{geography}.atlas.microsoft.com/routesets?api-version=2023-03-01-preview&datasetId={datasetId}

Avec des paramètres facultatifs:

POST https://{geography}.atlas.microsoft.com/routesets?api-version=2023-03-01-preview&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.
datasetId	query	True	string	ID du jeu de données à partir duquel créer le ou les ensembles de routes. Un ensemble de routes est créé pour chaque installation du jeu de données.
description	query		string	Description fournie par l’utilisateur de l’ensemble d’itinéraires.

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
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 OAuth2 Azure Active Directory . 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 uniques et des configurations Azure Active Directory. * 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.

• Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

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 a routeset from a previously created dataset

Exemple de requête

HTTP

POST https://us.atlas.microsoft.com/routesets?api-version=2023-03-01-preview&datasetId=[dataset-Id]&description=my routeset name

Exemple de réponse

Code d’état:

202

Operation-Location: https://us.atlas.microsoft.com/routesets/operations/[operation-Id]?2023-03-01-preview
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

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.