Data - Update

Referencia

Szolgáltatás:: Maps

API-verzió:: 2.0

Az adatfeltöltéssel korábban feltöltött adattartalmak frissítésére használható.

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ásba irányuló összes hívást frissíteni kell az 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.

Az Data Update API egy HTTP-kérés PUT , amely lehetővé teszi a hívó számára a korábban feltöltött adattartalom frissítését.

Ezt az API-t olyan forgatókönyvekben használhatja, mint a geofencesek hozzáadása vagy eltávolítása egy meglévő geofences-gyűjteményből vagy gyűjteményből. A geofencesek feltöltése az Adatfeltöltési API használatával történik az Azure Maps Geofencing Service-ben való használatra.

Vegye figyelembe, hogy az Update API lecseréli és felülbírálja a meglévő adattartalmat.

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 .

Frissítési kérelem elküldése

A tartalom frissítéséhez egy kérést PUT fog használni. A kérelem törzse tartalmazza azokat az új adatokat, amelyek lecserélik a meglévő adatokat. A Content-Type fejléc az adatok tartalomtípusára lesz beállítva, az elérési út pedig a udid frissíteni kívánt adatokat tartalmazza.

Ha például frissíteni szeretné a korábban az Upload API-val feltöltött geofences gyűjteményt, helyezze az új geofencetartalmat a kérelem törzsébe. Állítsa be a paramétert udid az elérési úton a udid feltöltési API-válaszban korábban kapott adatokhoz. Állítsa a fejlécet a Content-Type következő médiatípusok egyikére:

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

Íme egy mintakérési törzs egy egyszerű Geofence frissítéséhez. Ez egy 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
        }
    }]
}

A korábban feltöltött geofence sugara 100m volt. A fenti kérés 500m-re frissíti.

A Data Update API hosszú ideig futó műveletet hajt végre.

Adatfrissíté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.

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0

Opcionális paraméterekkel:

PUT https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0&description={description}

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.
udid	path	True	string	A tartalom egyedi adatazonosítója. Ezt `udid` egy sikeres adatfeltöltési hívásból kellett beszerezni.
api-version	query	True	string	Az Azure Maps API verziószáma.
description	query		string	A feltöltéshez megadandó leírás.

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. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket .

Kérelem törzse

Name	Típus	Description
UpdateContent	object	Az új tartalom, amely frissíti vagy lecseréli a korábban feltöltött tartalmat.

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 szerezze be az eredmény elérési útját. Fejlécek Resource-Location: string
202 Accepted		Kérelem elfogadva: A kérelem feldolgozásra elfogadva. Az állapot lekéréséhez használja a Operation-Location fejlécében található URL-címet. Fejlécek Operation-Location: string
Other Status Codes	ErrorResponse	Az adattárolási korlát az Azure Maps-fiókban érhető el. 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ő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 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á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ó megköveteli a fejléc használatát x-ms-client-id annak jelzéséhez, 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 az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a 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.

A Microsoft identitásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.

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 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 javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítésével érje el az Azure Maps REST API-kat, 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ási 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 a 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 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

Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences

Sample request

HTTP

PUT https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0

{
  "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/{operationId}?api-version=1.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
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érelem állapotállapota.

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 információtí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 hibacél.

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érelem állapotállapota.
warning	ErrorDetail	A hiba részletei.

LroStatus

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.

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