Data - Update Preview

Referencia

Service:: Maps

API Version:: 1.0

A Frissítési kérelem lehetővé teszi, hogy a hívó frissítse az adatfeltöltéssel korábban feltöltött adattartalmat.
A következőkre vonatkozik: S1 tarifacsomag.

A Data Update API lehetővé teszi, hogy a hívó frissítsen egy korábban feltöltött adattartalmat.

Ezt az API-t olyan forgatókönyvekben használhatja, mint a geokerítések hozzáadása vagy eltávolítása egy meglévő geokerítés-gyűjteményből vagy -gyűjteményből. A geokerítések feltöltése a Data Upload API használatával történik, a 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.

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.

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

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

Ha például frissíteni szeretné a korábban az Upload API használatával feltöltött geokerítések gyűjteményét, helyezze az új geokerítési tartalmat a kérelem törzsébe. Állítsa be a udid paramétert a korábban az udid upload API-válaszban kapott adatok elérési útjára. Állítsa a fejlécet Content-Type a 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 GeoJSONtalálható:

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

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

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

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

With optional parameters:

PUT 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 `udid` egy sikeres Data Upload API-hívásból kell beszerezni.
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.

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	ODataErrorResponse	Az adatfrissítés nem sikerült. 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. Headers Location: string
202 Accepted		Csak aszinkron kérés esetén támogatott. Kérelem elfogadva: A kérelem feldolgozásra el lett fogadva. Az eredmények újrapróbálkozásához vagy eléréséhez használja a Hely fejlécében található URL-címet. Headers 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. 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	ODataErrorResponse	Engedélyekkel, kapacitással vagy hitelesítésekkel 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 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

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?subscription-key=[subscription-key]&api-version=1.0

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

Sample Response

Status code:: 201

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

Response Body

{
  "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"
}

Status code:: 202

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

Status code:: 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."
  }
}

Status code:: 400

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

Status code:: 401

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

Status code:: 403

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

Status code:: 404

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

Status code:: 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érés állapotállapota.

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 tekintse meg a hely URI-ját. Ezt csak akkor adja meg, ha a kérés sikeresen befejeződött.
status	type	A kérés á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 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	ODataError	Ez az objektum akkor jelenik meg, ha hiba történik a Azure Maps API-ban.

type

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: