Data - List Preview

Referenz

Service:: Maps

API Version:: 1.0

Mit der List-Anforderung kann der Aufrufer eine Liste aller Inhalte abrufen, die zuvor mithilfe des Datenuploads hochgeladen wurden.
Gilt für: Tarif S1.

Mit dieser API kann der Aufrufer eine Liste aller Inhalte abrufen, die zuvor mithilfe der Datenupload-API hochgeladen wurden.

Hinweis

Einstellung des Azure Maps-Datendiensts

Der Azure Maps-Datendienst (v1 und v2) ist jetzt veraltet und wird am 16.09.2024 eingestellt. Um Dienstunterbrechungen zu vermeiden, müssen alle Aufrufe des Datendiensts aktualisiert werden, um den Azure Maps Datenregistrierungsdienst bis zum 16.09.24 zu verwenden. Weitere Informationen finden Sie unter So erstellen Sie eine Datenregistrierung.

Listenanforderung übermitteln

Zum Auflisten aller Kartendateninhalte stellen Sie eine GET Anforderung ohne zusätzliche Parameter aus.

Datenantwort auflisten

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

udid: Die eindeutige Daten-ID für die Datenressource.

location: Der Speicherort der Datenressource. Führen Sie an diesem Speicherort ein HTTP GET aus, um die Daten herunterzuladen.

Hier sehen Sie eine Beispielantwort, die das udid und location von 3 Datenressourcen zurückgibt:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

GET https://{geography}.atlas.microsoft.com/mapData?api-version=1.0

With optional parameters:

GET https://{geography}.atlas.microsoft.com/mapData?subscription-key={subscription-key}&api-version=1.0

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind wir und eu.
api-version	query	True	string	Versionsnummer der Azure Maps API. Aktuelle Version ist 1.0
subscription-key	query		string	Einer der Azure Maps-Schlüssel, die über ein Azure Map-Konto bereitgestellt werden. Weitere Informationen zum Verwalten der Authentifizierung finden Sie in diesem Artikel .

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	MapDataListResponse	Die Listendatenanforderung wurde erfolgreich abgeschlossen. Der Antworttext enthält eine Liste aller zuvor hochgeladenen Daten. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Ungültige Anforderung: Mindestens ein Parameter wurde fälschlicherweise angegeben oder schließen sich gegenseitig aus.
401 Unauthorized	ODataErrorResponse	Zugriff aufgrund eines ungültigen Abonnementschlüssels oder eines ungültigen Microsoft Entra ID Bearertokens verweigert. Stellen Sie sicher, dass Sie einen gültigen Schlüssel für ein aktives Azure-Abonnement und eine Maps-Ressource bereitstellen. Überprüfen Sie andernfalls den WWW-Authenticate-Header auf Fehlercode und Eine Beschreibung des bereitgestellten Microsoft Entra ID Bearertokens. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Berechtigungs-, Kapazitäts- oder Authentifizierungsprobleme.
404 Not Found	ODataErrorResponse	Nicht gefunden: Die angeforderte Ressource konnte nicht gefunden werden, ist aber möglicherweise in Zukunft wieder verfügbar.
500 Internal Server Error	ODataErrorResponse	Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten. Versuchen Sie es später noch mal.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung in 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Dies ist ein gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal erstellen oder PowerShell, CLI, Azure SDKs oder REST-API verwenden.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, 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 zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Type: apiKey
In: query

SAS Token

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge für die Zuordnungskontoressource zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?subscription-key=[subscription-key]&api-version=1.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Status code:: 400

{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}

Status code:: 401

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}

Status code:: 403

{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}

Status code:: 404

{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}

Status code:: 500

{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitionen

Name	Beschreibung
MapDataDetailInfo	Detailinformationen für die Daten.
MapDataListResponse	Das Antwortmodell für die Datenlisten-API. Gibt eine Liste aller zuvor hochgeladenen Daten zurück.
ODataError	Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.
ODataErrorResponse	Dieses Antwortobjekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.

MapDataDetailInfo

Detailinformationen für die Daten.

Name	Typ	Beschreibung
location	string	Der Speicherort der Daten. Führen Sie an diesem Speicherort ein HTTP `GET` aus, um die Daten herunterzuladen.
sizeInBytes	integer	Die Größe des Inhalts in Bytes.
udid	string	Die eindeutige Daten-ID für die Daten.
uploadStatus	string	Die aktuelle Upload-status des Inhalts.

MapDataListResponse

Das Antwortmodell für die Datenlisten-API. Gibt eine Liste aller zuvor hochgeladenen Daten zurück.

Name	Typ	Beschreibung
mapDataList	MapDataDetailInfo[]	Eine Liste aller zuvor hochgeladenen Daten.

ODataError

Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.

Name	Typ	Beschreibung
code	string	Der ODataError-Code.
details	ODataError[]	Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.
message	string	Falls verfügbar, eine für Menschen lesbare Beschreibung des Fehlers.
target	string	Falls verfügbar, das Ziel, das den Fehler verursacht.

ODataErrorResponse

Dieses Antwortobjekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.

Name	Typ	Beschreibung
error	ODataError	Dieses Objekt wird zurückgegeben, wenn ein Fehler in der Azure Maps-API auftritt.

Share via