Data - Upload Preview

Referencia

Szolgáltatás:: Maps

API-verzió:: 1.0

A Feltöltési kérelem lehetővé teszi, hogy a hívó feltöltse az adattartalmakat a Azure Maps fiókjába.
A következőkre vonatkozik: S1 tarifacsomag.

Az Adatfeltöltés API lehetővé teszi, hogy a hívó feltöltse az adattartalmat a Azure Maps szolgáltatásba. Ezt az API-t olyan forgatókönyvekben használhatja, mint például geofences GeoJSON gyűjtemények feltöltése formátumban, a Azure Maps Geofencing Szolgáltatásban való használatra.

Megjegyzés

Azure Maps adatszolgáltatás kivonása

A 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ás összes hívását frissíteni kell a 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.

Feltöltési kérelem elküldése

A tartalom feltöltéséhez egy kérést POST fog használni. A kérelem törzse tartalmazza a feltöltendő adatokat. A Content-Type fejléc az adatok tartalomtípusára lesz beállítva.

Ha például egy geofences GeoJSON gyűjteményt szeretne feltölteni formátumban, állítsa a kérelem törzsét a geofenciatartalomra. Állítsa a dataFormat lekérdezési paramétert geojson értékre, és állítsa a Content-Type fejlécet az alábbi médiatípusok egyikére:

application/json
application/vnd.geo+json
application/octet-stream

Íme egy mintakérési törzs egy egyszerű Geofence feltöltéséhez, amely körgeometriaként jelenik meg egy középpont és egy sugár használatával. Az alábbi minta a következő helyen található GeoJSON:

{
    "type": "FeatureCollection",
    "features": [{
        "type": "Feature",
        "geometry": {
            "type": "Point",
            "coordinates": [-122.126986, 47.639754]
        },
        "properties": {
            "geometryId": "001",
            "radius": 500
        }
    }]
}

Az Adatfeltöltés API hosszú ideig futó műveletet hajt végre.

Adatfeltöltési korlátok

Vegye figyelembe, hogy jelenleg minden Azure Maps fiók rendelkezik adattárolási korlátkal. A tárterületkorlát elérése után az összes új feltöltési API-hívás http-hibaválaszt 409 Conflict ad vissza. Az Adattörlési API-val bármikor törölheti a régi/nem használt tartalmakat, és helyet hozhat létre az új feltöltésekhez.

POST https://{geography}.atlas.microsoft.com/mapData/upload?api-version=1.0&dataFormat={dataFormat}

Opcionális paraméterekkel:

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

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 Létrehozó erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	A Azure Maps API verziószáma. Az aktuális verzió 1.0
dataFormat	query	True	UploadDataFormat	A feltöltött tartalom adatformátuma.
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 használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Kérelem törzse

Name	Típus	Description
UploadContent	object	A feltöltendő tartalom.

Válaszok

Name	Típus	Description
200 OK	ODataErrorResponse	Az adatfeltöltés sikertelen volt. A feltöltött tartalom nem felelt meg az összes ellenőrzési ellenőrzésnek. A válasz törzse tartalmazza az összes észlelt hibát.
201 Created	LongRunningOperationResult	Az erőforrás létrehozása sikerült. Fejlécek Location: string
202 Accepted		Csak aszinkron kérés esetén támogatott. Kérelem elfogadva: A kérelem feldolgozásra elfogadva. Az eredmények újbóli megkísérléséhez vagy eléréséhez használja a Helyfejléc URL-címét. Fejlécek Location: string
400 Bad Request	ODataErrorResponse	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	ODataErrorResponse	A hozzáférés érvénytelen előfizetési kulcs vagy érvénytelen Microsoft Entra ID tulajdonosi jogkivonat miatt megtagadva. Győződjön meg arról, hogy érvényes kulcsot ad meg egy aktív Azure-előfizetéshez és a 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. Fejlécek WWW-Authenticate: string
403 Forbidden	ODataErrorResponse	Engedélyekkel, kapacitással vagy hitelesítési problémákkal kapcsolatos problémák.
404 Not Found	ODataErrorResponse	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	ODataErrorResponse	Hiba történt a kérés feldolgozása során. Próbálkozzon újra később.

Biztonság

AADToken

Ezek az OAuth 2.0-folyamatok Microsoft Entra. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a 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, a REST API-khoz Azure Maps engedélyekkel rendelkező 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ó a fejléc használatával x-ms-client-id jelzi, 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 Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A 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ásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintés.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

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 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 azt javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével férhessen hozzá Azure Maps REST API-khoz, 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, amely a Azure Maps erőforrás SAS listázási műveletéből jön létre 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 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

Upload GeoJSON data containing geometries that represent a collection of geofences

Mintakérelem

HTTP

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.126986,
          47.639754
        ]
      },
      "properties": {
        "geometryId": "001",
        "radius": 500
      }
    }
  ]
}

Mintaválasz

Állapotkód:: 201

Location: https://atlas.microsoft.com/mapData/metadata/{udid}?api-version=1.0
Access-Control-Expose-Headers: Location

{
  "operationId": "{operationId}",
  "status": "Succeeded",
  "created": "2020-01-02 1:02:03 AM +00:00",
  "resourceLocation": "https://atlas.microsoft.com/mapData/metadata/{resourceId}?api-version=1.0"
}

Állapotkód:: 202

operation-Location: https://atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0
Access-Control-Expose-Headers: Location

Állapotkód:: 200

{
  "error": {
    "code": "400 Bad Request",
    "message": "Upload request failed. Your data has been removed as we encountered the following problems with it: Map data is not a valid GeoJSON geometry."
  }
}

Állapotkód:: 400

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

Állapotkód:: 401

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

Állapotkód:: 403

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

Állapotkód:: 404

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

Állapotkód:: 500

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

Definíciók

Name	Description
LongRunningOperationResult	A Long-Running Operations API válaszmodellje.
ODataError	Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
ODataErrorResponse	Ez a válaszobjektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
type	A kérelem állapotállapota.
UploadDataFormat	A feltöltött tartalom adatformátuma.

LongRunningOperationResult

A Long-Running Operations API válaszmodellje.

Name	Típus	Description
created	string	A létrehozott időbélyeg.
error	ODataError	Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
operationId	string	A hosszú ideig futó művelet azonosítója.
resourceLocation	string	A létrehozott erőforrással kapcsolatos részletekért a hely URI-ja. Ez csak akkor történik meg, ha a kérés sikeresen befejeződött.
status	type	A kérelem állapotállapota.
warning	ODataError	Ez az objektum 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	ODataError[]	Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.
message	string	Ha elérhető, a hiba ember által olvasható 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	ODataError	Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.

type

A kérelem állapotállapota.

Name	Típus	Description
Failed	string	A kérés egy vagy több hibával rendelkezik.
NotStarted	string	A kérés feldolgozása még nem kezdődött el.
Running	string	A kérés megkezdte a feldolgozást.
Succeeded	string	A kérés sikeresen befejeződött.

UploadDataFormat

A feltöltött tartalom adatformátuma.

Name	Típus	Description
geojson	string	A GeoJSON egy JSON-alapú térinformatikai adatcsere-formátum.
zip	string	Tömörített adatformátum.

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