Data - Download Preview
A Letöltési kérelem lehetővé teszi, hogy a hívó letöltse az adatfeltöltéssel korábban feltöltött adatokat.
A következőkre vonatkozik: S1 tarifacsomag.
Ez az API lehetővé teszi, hogy a hívó letöltsön egy korábban feltöltött adattartalmat.
Ezt az API-t olyan forgatókönyvekben használhatja, mint a korábban feltöltött geokerítések egy meglévő gyűjteményének letöltése az Adatfeltöltés API használatával a Azure Maps Geofencing Szolgáltatásban való használatra.
Megjegyzés
Azure Maps data service kivezetése
A Azure Maps Data service (v1 és v2) elavult, és 24.09.16-án megszűnik. A szolgáltatáskimaradások elkerülése érdekében az adatszolgáltatás összes hívását frissíteni kell a Azure Maps Data Registry szolgáltatás használatához 2024. 09. 16-ig. További információ: Adatregisztrációs adatbázis létrehozása.
Letöltési kérelem elküldése
A tartalom letöltéséhez használjon egy kérést GET
, amelyben az elérési út tartalmazza a udid
letölteni kívánt adatokat. Ha szeretné, megadhat egy Accept
fejlécet is az adatválasz beállításához Content-Type
.
Ha például az Upload API használatával korábban feltöltött geokerítések gyűjteményét szeretné letölteni, állítsa a paramétert az udid
elérési útban a udid
korábban a feltöltési API-válaszban kapott adatokra, és állítsa a Accept
fejlécet az alábbi médiatípusok valamelyikére:
application/json
application/vnd.geo+json
application/octet-stream
Adatválasz letöltése
A Download API HTTP-választ 200 OK
udid
ad vissza, ha megtalálható az átadott adaterőforrás, ahol a válasz törzse tartalmazni fogja az adaterőforrás tartalmát.
A rendszer HTTP-hibaválaszt 400 Bad Request
ad vissza, ha az átadott udid
adaterőforrás nem található.
Íme egy mintaválasz törzse a korábban az Upload API használatával feltöltött egyszerű geofence-hez GeoJSON
:
{
"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
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ó a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu. |
udid
|
path | True |
string |
A tartalom egyedi adatazonosítója. A-t |
api-version
|
query | True |
string |
Azure Maps API verziószáma. Az aktuális verzió 1.0 |
subscription-key
|
query |
string |
Az Azure Map-fiókból biztosított Azure Maps kulcsok egyike. A hitelesítés kezelésével kapcsolatos részletekért tekintse meg ezt a cikket . |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
object |
Az adatletöltési kérelem sikeresen befejeződött. A válasz törzse tartalmazni fogja az átadott fájl tartalmát. Headers Content-Type: string |
400 Bad Request |
Hibás kérés: egy vagy több paraméter helytelenül lett megadva, vagy kölcsönösen kizáróak. |
|
401 Unauthorized |
A hozzáférés érvénytelen előfizetési kulcs vagy érvénytelen Microsoft Entra ID tulajdonosi jogkivonat miatt megtagadva. Mindenképpen adjon meg érvényes kulcsot egy aktív Azure-előfizetéshez és Maps-erőforráshoz. Ellenkező esetben ellenőrizze a WWW-Authenticate fejlécet a hibakódhoz és a megadott Microsoft Entra ID tulajdonosi jogkivonat leírásához. Headers WWW-Authenticate: string |
|
403 Forbidden |
Engedélyekkel, kapacitással vagy hitelesítésekkel kapcsolatos problémák. |
|
404 Not Found |
Nem található: a kért erőforrás nem található, de a jövőben újra elérhető lehet. |
|
500 Internal Server Error |
Hiba történt a kérés feldolgozása során. Próbálkozzon újra később. |
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 Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 rest API-Azure Maps 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ás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.
Jegyzetek
- Ez a biztonsági definíció megköveteli a fejléc használatát annak
x-ms-client-id
jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.
A Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. 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ése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
* A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.
- A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.
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
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy 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én javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Type:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Type:
apiKey
In:
header
Példák
Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Sample Request
GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?subscription-key=[subscription-key]&api-version=1.0
Sample Response
{
"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."
}
}
Definíciók
Name | Description |
---|---|
OData |
Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban. |
OData |
Ez a válaszobjektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban. |
ODataError
Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
Name | Típus | Description |
---|---|---|
code |
string |
Az ODataError kód. |
details |
Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban. |
|
message |
string |
Ha elérhető, a hiba emberi olvasásra alkalmas leírása. |
target |
string |
Ha elérhető, a hibát okozó cél. |
ODataErrorResponse
Ez a válaszobjektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
Name | Típus | Description |
---|---|---|
error |
Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban. |