Data - List

Referencia

Szolgáltatás:: Maps

API-verzió:: 2.0

A használatával lekérheti az adatfeltöltéssel korábban feltöltött összes tartalom listáját.

Megjegyzés

Az Azure Maps data service kivezetése

Az Azure Maps Adatszolgáltatás ( v1 és v2) elavult, és 24.09.16-án megszűnik. A szolgáltatáskimaradások elkerülése érdekében az Adatszolgáltatásba irányuló összes hívást frissíteni kell az Azure Maps Data Registry szolgáltatás használatához 24.09.16-ig. További információ: Adatregisztrációs adatbázis létrehozása.

Az Data List API egy HTTP-kérés GET , amely lehetővé teszi, hogy a hívó lekérje a data upload API használatával korábban feltöltött összes tartalom listáját.

Listakérés elküldése

Az összes térképadat-tartalom listázásához további paraméterek nélküli kérést GET fog kiadni.

Adatválasz listázása

Az Adatlista API az összes adat json teljes listáját adja vissza formátumban. A válasz az egyes adaterőforrások következő adatait tartalmazza:

udid – Az adaterőforrás egyedi adatazonosítója.

location – Az adaterőforrás helye. Futtasson egy HTTP-kérést GET ezen a helyen az adatok letöltéséhez.

Íme egy mintaválasz, udidlocation amely 3 adaterőforrást ad vissza:

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.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://us.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://us.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=2.0

URI-paraméterek

Name	In	Kötelező	Típus	Description
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található az Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	Az Azure Maps API verziószáma.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .

Válaszok

Name	Típus	Description
200 OK	MapDataListResult	Az adatkérés listázása sikeresen befejeződött. A válasz törzse tartalmazza a korábban feltöltött adatok listáját.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0 folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható az Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps-erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel, vagy egy vagy több Azure Maps REST API-ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát x-ms-client-id annak jelzéséhez, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft identitásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.

Típus: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps-fiókot hoz létre az Azure Portalon, vagy a PowerShell, a CLI, az Azure SDK-k vagy a REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével érje el az Azure Maps REST API-kat, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázási műveletéből jön létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

List all the previously uploaded data

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.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://us.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://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

Definíciók

Name	Description
DataFormat	A feltöltött tartalom adatformátuma.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
MapData	Az adatok részletes információi.
MapDataListResult	A Data List API válaszmodellje. A korábban feltöltött adatok listáját adja vissza.
UploadStatus	A tartalom aktuális feltöltési állapota.

DataFormat

A feltöltött tartalom adatformátuma.

Name	Típus	Description
dwgzippackage	string	DWG-fájlt tartalmazó ZIP-csomag.
geojson	string	A GeoJSON egy JSON-alapú térinformatikai adatcsere-formátum.
zip	string	Tömörített adatformátum.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

MapData

Az adatok részletes információi.

Name	Típus	Description
dataFormat	DataFormat	A feltöltött tartalom adatformátuma.
description	string	Az aktuális leírás.
location	string	Az adatok helye. Futtasson egy HTTP-kérést `GET` ezen a helyen az adatok letöltéséhez.
sizeInBytes	integer	A tartalom mérete bájtban.
udid	string	Az adatok egyedi adatazonosítója.
uploadStatus	UploadStatus	A tartalom aktuális feltöltési állapota.

MapDataListResult

A Data List API válaszmodellje. A korábban feltöltött adatok listáját adja vissza.

Name	Típus	Description
mapDataList	MapData[]	A korábban feltöltött adatok listája.

UploadStatus

A tartalom aktuális feltöltési állapota.

Name	Típus	Description
Completed	string	A feltöltés ellenőrzése és feldolgozása befejeződött
Failed	string	Ellenőrzés és/vagy feldolgozási hiba feltöltése
Pending	string	A feltöltés feldolgozása folyamatban van

Megosztás a következőn keresztül: