Alias - List

Verwenden Sie , um eine Liste von Aliasen abzurufen.

Die List API ist eine HTTP-Anforderung GET , mit der der Aufrufer eine Liste aller vorhandenen Aliase abrufen kann.

Übermitteln einer Listenanforderung

Um alle Aliase auflisten zu können, geben Sie eine GET Anforderung ohne zusätzliche Parameter aus.

Datenantwort auflisten

Die Listen-API gibt die vollständige Liste aller Aliase im json Format zurück. Die Antwort enthält die folgenden Details für jede Aliasressource:

createdTimestamp: Der Zeitstempel, den der Alias erstellt hat. Format yyyy-MM-ddTHH:mm:sss.sssZ aliasId – Die ID für den Alias. creatorDataItemId: Die ID für das Erstellerdatenelement, auf das dieser Alias verweist (kann NULL sein, wenn der Alias nicht zugewiesen wurde). lastUpdatedTimestamp: Die letzte Zuweisung des Alias zu einer Ressource. Format yyyy-MM-ttTHH:mm:ss.sssZ

Eine Beispielantwort, die zwei Aliasressourcen zurückgibt:

{
  "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

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

Hinweise

• Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

• Weitere Informationen zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der beim Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API bereitgestellt wird.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

Für öffentlich zugängliche Anwendungen wird empfohlen, den Ansatz vertraulicher Clientanwendungen für den Zugriff auf Azure Maps REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

List all the previously created aliases

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

{
  "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"
    }
  ]
}

Definitionen

Alias

Ausführliche Informationen für den Alias.

AliasListResult

Das Antwortmodell für die Listen-API. Gibt eine Liste aller zuvor erstellten Aliase zurück.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort