Data - Download Preview
Žádost o stažení umožňuje volajícímu stáhnout data dříve nahraná pomocí funkce Nahrání dat.
Platí pro: Cenová úroveň S1.
Toto rozhraní API umožňuje volajícímu stáhnout dříve nahraný datový obsah.
Toto rozhraní API můžete použít ve scénáři, jako je stažení existující kolekce geografických monitorů nahraných dříve pomocí rozhraní API pro nahrávání dat pro použití v naší službě Azure Maps Geofencing Service.
Poznámka
Vyřazení služby Azure Maps Data
Služba Azure Maps Data (v1 i v2) je teď zastaralá a 16. 9. 24. se vyřadí z provozu. Aby nedošlo k přerušení služeb, bude potřeba do 16. 9. 24. všechna volání služby Data Service aktualizovat tak, aby používala službu Azure Maps Data Registry. Další informace najdete v tématu Vytvoření registru dat.
Odeslat žádost o stažení
Ke stažení obsahu použijete GET
požadavek, ve kterém cesta bude obsahovat udid
data ke stažení. Volitelně můžete také předat hlavičku Accept
a určit tak předvolbu Content-Type
pro odpověď na data.
Pokud například chcete stáhnout kolekci geografických zóny, které se dříve nahrály pomocí rozhraní API pro nahrávání, nastavte udid
parametr v cestě k udid
datům přijatým dříve v odpovědi rozhraní API pro nahrávání a nastavte hlavičku Accept
na některý z následujících typů médií:
application/json
application/vnd.geo+json
application/octet-stream
Odpověď na stažení dat
Rozhraní API pro stahování vrátí odpověď HTTP 200 OK
, pokud se najde datový prostředek s předávaným udid
datovým prostředkem, kde tělo odpovědi bude obsahovat obsah datového prostředku.
Pokud se prostředek dat s předaným udid
souborem nenajde, vrátí se chybová odpověď HTTP400 Bad Request
.
Tady je ukázkový text odpovědi pro jednoduchou geografickou zóny reprezentovanou dříve GeoJSON
nahranou pomocí rozhraní API pro nahrávání:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.126986, 47.639754]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}]
}
GET https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=1.0
GET https://{geography}.atlas.microsoft.com/mapData/{udid}?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. |
udid
|
path | True |
string |
Jedinečné ID dat pro obsah. Musí |
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 účtu Azure Map. 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 je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
object |
Žádost o stažení dat byla úspěšně dokončena. Text odpovědi bude obsahovat obsah předaného souboru Hlavičky Content-Type: string |
400 Bad Request |
Chybný požadavek: Jeden nebo více parametrů bylo zadáno nesprávně nebo se vzájemně vylučují. |
|
401 Unauthorized |
Přístup byl odepřen kvůli neplatnému klíči předplatného nebo neplatnému nosnýmu tokenu Microsoft Entra ID. 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. Hlavičky WWW-Authenticate: string |
|
403 Forbidden |
Problémy s oprávněním, kapacitou nebo ověřováním |
|
404 Not Found |
Nenalezený: Požadovaný prostředek se nepovedlo najít, ale v budoucnu může být znovu k dispozici. |
|
500 Internal Server Error |
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 složené 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 pro konkrétní rozhraní API a obory.
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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
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.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
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ůže každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.
U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Typ:
apiKey
V:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v Azure Maps prostředku 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 autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.
Typ:
apiKey
V:
header
Příklady
Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Ukázkový požadavek
GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?subscription-key=[subscription-key]&api-version=1.0
Ukázková odpověď
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.126986,
47.639754
]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}
]
}
{
"error": {
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
{
"error": {
"code": "401 Unauthorized",
"message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
}
{
"error": {
"code": "403 Forbidden",
"message": "Permission, capacity, or authentication issues."
}
}
{
"error": {
"code": "404 NotFound",
"message": "Not Found: the requested resource could not be found, but it may be available again in the future."
}
}
{
"error": {
"code": "500 InternalServerError",
"message": "An error occurred while processing the request. Please try again later."
}
}
Definice
Name | Description |
---|---|
OData |
Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps. |
OData |
Tento objekt odpovědi se vrátí, když dojde k chybě v rozhraní API Azure Maps. |
ODataError
Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps.
Name | Typ | Description |
---|---|---|
code |
string |
Kód ODataError. |
details |
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 |
Tento objekt se vrátí, když dojde k chybě v rozhraní API Azure Maps. |