Alias - List

Référence

Service:: Maps Creator

API Version:: 2.0

Utilisez pour obtenir une liste d’alias.

L’API List est une requête HTTP GET qui permet à l’appelant d’extraire une liste de tous les alias existants.

Envoyer une demande de liste

Pour répertorier tous vos alias, vous allez émettre une GET requête sans paramètres supplémentaires.

Réponse aux données de liste

L’API List retourne la liste complète de tous les alias au json format. La réponse contient les détails suivants pour chaque ressource d’alias :

createdTimestamp : horodatage auquel l’alias a été créé. Format aaaa-MM-ddTHH :mm :ss.sssZ aliasId : ID de l’alias. creatorDataItemId : ID de l’élément de données créateur auquel cet alias fait référence (peut être null si l’alias n’a pas été affecté). lastUpdatedTimestamp : dernière fois que l’alias a été affecté à une ressource. Format aaaa-MM-jjTHH :mm :ss.sssZ

Exemple de réponse retournant 2 ressources d’alias :

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11.123Z",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
    },
    {
      "createdTimestamp": "2020-02-18T19:53:33.123Z",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
    }
  ]
}

GET https://{geography}.atlas.microsoft.com/aliases?api-version=2.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.

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	AliasListResult	Lister la demande d’alias terminée avec succès. Le corps de la réponse contient une liste de tous les alias créés précédemment.
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 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.

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 created aliases

Sample Request

HTTP

GET https://us.atlas.microsoft.com/aliases?api-version=2.0

Sample Response

Status code:: 200

{
  "aliases": [
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
      "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
      "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00"
    },
    {
      "createdTimestamp": "2020-02-13T21:19:11+00:00",
      "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
      "creatorDataItemId": null,
      "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00"
    }
  ]
}

Définitions

Nom	Description
Alias	Informations détaillées pour l’alias.
AliasListResult	Modèle de réponse pour l’API De liste. Retourne une liste de tous les alias créés précédemment.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

Alias

Informations détaillées pour l’alias.

Nom	Type	Description
aliasId	string	ID de l’alias.
createdTimestamp	string	Horodatage créé pour l’alias.
creatorDataItemId	string	ID de l’élément de données du créateur auquel cet alias fait référence (peut être null si l’alias n’a pas été affecté).
lastUpdatedTimestamp	string	Horodatage de la dernière fois que l’alias a été attribué.

AliasListResult

Modèle de réponse pour l’API De liste. Retourne une liste de tous les alias créés précédemment.

Nom	Type	Description
aliases	Alias[]	Liste de tous les alias créés précédemment.
nextLink	string	Le cas échéant, emplacement de la page de données suivante.

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.

Partager via