Data - Upload

Referencia

Szolgáltatás:: Maps

API-verzió:: 2.0

Adattartalom feltöltése Azure Maps-fiókba.

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áshoz intézett összes hívást frissíteni kell az 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.

Az Data Upload API egy HTTP-kérés POST , amely lehetővé teszi, hogy a hívó adattartalmat töltsön fel az Azure Maps szolgáltatásba. Ezt az API-t olyan forgatókönyvekben használhatja, mint a Geofences-gyűjtemények GeoJSONfeltöltése formátumban az Azure Maps Geofencing Service-ben való használatra.

Fontos

Ezzel a funkcióval elfogadja az előzetes verzióra vonatkozó jogi feltételeket. További részletekért tekintse meg az előzetes verzió kiegészítő feltételeit .

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

A tartalom feltöltéséhez kérést POST kell használnia. A kérelem törzse tartalmazni fogja a feltöltendő adatokat. A dataFormat lekérdezési paraméter tartalmazni fogja az adatok formátumát, a dataSharingLevel lekérdezési paraméter pedig az adatok megosztási szintjét. A Content-Type fejléc az adatok tartalomtípusára lesz beállítva.

Ha például geokerítések GeoJSON gyűjteményét szeretné feltölteni formátumban, állítsa a kérelem törzsét a geokerítési tartalomra. Á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 valamelyiké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 GeoJSONtalálható:

{
    "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áttal. A tárterületkorlát elérése után az összes új feltöltési API-hívás HTTP-hibaüzenetet 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?api-version=2.0&dataFormat={dataFormat}

Opcionális paraméterekkel:

POST https://{geography}.atlas.microsoft.com/mapData?api-version=2.0&description={description}&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ó 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.
dataFormat	query	True	DataFormat	A feltöltött tartalom adatformátuma.
description	query		string	A feltöltéshez megadandó leírás.

Kérelem fejléce

Media Types: "application/json", "application/octet-stream"

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 az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID security Azure Mapsben való használatához az alábbi cikkek nyújtanak útmutatást.

Kérelem törzse

Media Types: "application/json", "application/octet-stream"

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

Válaszok

Name	Típus	Description
200 OK	LongRunningOperationResult	A művelet fut vagy befejeződött. Ha a művelet sikeres volt, a Resource-Location fejléc használatával kérje le az eredmény elérési útját. Fejlécek Resource-Location: string
202 Accepted		Kérelem elfogadva: A kérelem feldolgozásra el lett fogadva. Az állapot lekéréséhez használja a Operation-Location fejlécben található URL-címet. Fejlécek Operation-Location: string
Other Status Codes	ErrorResponse	Az adattárolási korlát elérése az Azure Maps-fiókban történik. 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.
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é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 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á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

Ehhez a biztonsági definícióhoz a x-ms-client-id fejléc használatával kell jelezni, hogy az alkalmazás melyik Azure Maps-erőforráshoz kér hozzáférést. 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-beli 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 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.

További információ a Microsoft identitásplatformról: A Microsoft identitásplatformjának áttekintése.

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 PowerShell, CLI, Azure SDK-k 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ében javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja az Azure Maps REST API-k eléréséhez, 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ása 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 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 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.

Típus: apiKey
In: header

Példák

Upload GeoJSON data containing geometries that represent a collection of geofences

Sample request

HTTP

POST https://us.atlas.microsoft.com/mapData?api-version=2.0&dataFormat=geojson

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

Sample response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Status code:: 409

{
  "error": {
    "code": "409 Conflict",
    "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads."
  }
}

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
LongRunningOperationResult	A Long-Running Operations API válaszmodellje.
LroStatus	A kérés állapotá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 adattí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 hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

LongRunningOperationResult

A Long-Running Operations API válaszmodellje.

Name	Típus	Description
created	string	A létrehozott időbélyeg.
error	ErrorDetail	A hiba részletei.
operationId	string	A hosszú ideig futó művelet azonosítója.
status	LroStatus	A kérés állapotállapota.
warning	ErrorDetail	A hiba részletei.

LroStatus

A kérés állapotállapota.

Name	Típus	Description
Failed	string	A kérelem 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 feldolgozása megkezdődött.
Succeeded	string	A kérés sikeresen befejeződött.

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