Data - List Preview

Reference

Service:: Maps

API Version:: 1.0

Požadavek Na seznam umožňuje volajícímu načíst seznam veškerého obsahu, který byl dříve nahrán pomocí nahrání dat.
Platí pro: Cenová úroveň S1.

Toto rozhraní API umožňuje volajícímu načíst seznam veškerého obsahu nahraného dříve pomocí rozhraní API pro nahrávání dat.

Poznámka

vyřazení služby Azure Maps Data Service

Služba Azure Maps Data (v1 i v2) je teď zastaralá a 16. 9. 24. bude vyřazena. Aby nedocházelo k přerušení služeb, bude potřeba do 16. 9. do 24. 9. aktualizovat všechna volání datové služby tak, aby používala službu Azure Maps Data Registry. Další informace najdete v tématu Vytvoření registru dat.

Odeslat žádost o seznam

Pokud chcete zobrazit seznam veškerého obsahu mapových dat, odešlete GET požadavek bez dalších parametrů.

Odpověď na data seznamu

Rozhraní API seznam dat vrátí úplný seznam všech dat ve json formátu. Odpověď obsahuje následující podrobnosti o každém datovém prostředku:

udid – jedinečné ID dat datového prostředku.

location – umístění datového prostředku. Spuštěním protokolu HTTP GET v tomto umístění stáhněte data.

Tady je ukázková odpověď vracející udidlocation a 3 datové prostředky:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
geography	path	True	string	Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps. Aktuální verze je 1.0.
subscription-key	query		string	Jeden z Azure Maps klíčů zadaných z mapového účtu Azure. Podrobnosti o správě ověřování najdete v tomto článku .

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	MapDataListResponse	Žádost o výpis dat se úspěšně dokončila. Text odpovědi obsahuje seznam všech dříve nahraných dat. Headers Content-Type: string
400 Bad Request	ODataErrorResponse	Chybný požadavek: Jeden nebo více parametrů bylo zadáno nesprávně nebo se vzájemně vylučují.
401 Unauthorized	ODataErrorResponse	Přístup byl odepřen kvůli neplatnému klíči předplatného nebo neplatnému Microsoft Entra ID nosný token. Nezapomeňte zadat platný klíč pro aktivní předplatné Azure a prostředek Maps. V opačném případě ověřte kód chyby a popis zadaného Microsoft Entra ID nosného tokenu v hlavičce WWW-Authenticate. Headers WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Problémy s oprávněním, kapacitou nebo ověřováním
404 Not Found	ODataErrorResponse	Nenalezený: Požadovaný prostředek se nepodařilo najít, ale v budoucnu může být znovu dostupný.
500 Internal Server Error	ODataErrorResponse	Při zpracování požadavku došlo k chybě. Zkuste to později.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Type: 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

Jedná se o sdílený klíč, který se zřídí při vytvoření účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

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."
  }
}

Definice

Name	Description
MapDataDetailInfo	Podrobné informace o datech
MapDataListResponse	Model odpovědi pro rozhraní API seznamu dat. Vrátí seznam všech dříve nahraných dat.
ODataError	Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps.
ODataErrorResponse	Tento objekt odpovědi se vrátí, když dojde k chybě v rozhraní API Azure Maps.

MapDataDetailInfo

Podrobné informace o datech

Name	Typ	Description
location	string	Umístění dat. Spuštěním protokolu HTTP `GET` v tomto umístění stáhněte data.
sizeInBytes	integer	Velikost obsahu v bajtech.
udid	string	Jedinečné ID dat pro data
uploadStatus	string	Aktuální stav nahrávání obsahu.

MapDataListResponse

Model odpovědi pro rozhraní API seznamu dat. Vrátí seznam všech dříve nahraných dat.

Name	Typ	Description
mapDataList	MapDataDetailInfo[]	Seznam všech dříve nahraných dat.

ODataError

Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps.

Name	Typ	Description
code	string	Kód ODataError.
details	ODataError[]	Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps.
message	string	Pokud je k dispozici, popis chyby čitelný pro člověka.
target	string	Pokud je k dispozici, cíl, který chybu způsobuje.

ODataErrorResponse

Tento objekt odpovědi se vrátí, když dojde k chybě v rozhraní API Azure Maps.

Name	Typ	Description
error	ODataError	Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps.

Share via