Data - Update

Referensi

Service:: Maps

API Version:: 2.0

Gunakan untuk memperbarui konten data yang sebelumnya diunggah menggunakan Unggahan Data.

Catatan

Azure Maps Penghentian layanan data

Layanan Azure Maps Data (v1 dan v2) sekarang tidak digunakan lagi dan akan dihentikan pada 16/9/24. Untuk menghindari gangguan layanan, semua panggilan ke layanan Data perlu diperbarui untuk menggunakan layanan Azure Maps Data Registry sebesar 16/9/24. Untuk informasi selengkapnya, lihat Cara membuat registri data.

Data Update API adalah permintaan HTTP PUT yang memungkinkan pemanggil memperbarui konten data yang diunggah sebelumnya.

Anda dapat menggunakan API ini dalam skenario seperti menambahkan atau menghapus geofence ke atau dari kumpulan geofence yang ada. Geofences diunggah menggunakan API Pengunggahan Data, untuk digunakan dalam Azure Maps Geofencing Service.

Harap dicatat bahwa API Pembaruan akan menggantikan dan mengambil alih konten data yang ada.

Penting

Dengan menggunakan fitur ini, Anda menyetujui persyaratan hukum pratinjau. Lihat Persyaratan Tambahan Pratinjau untuk detail tambahan.

Kirim Permintaan Pembaruan

Untuk memperbarui konten, Anda akan menggunakan PUT permintaan. Isi permintaan akan berisi data baru yang akan menggantikan data yang ada. Header Content-Type akan diatur ke jenis konten data, dan jalur akan berisi data yang udid akan diperbarui.

Misalnya, untuk memperbarui kumpulan geofence yang sebelumnya diunggah menggunakan API Unggah, tempatkan konten geofence baru di isi permintaan. Atur udid parameter di jalur ke udid data yang diterima sebelumnya dalam respons API unggahan. Dan atur Content-Type header ke salah satu jenis media berikut:

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

Berikut adalah isi permintaan sampel untuk memperbarui Geofence sederhana. Ini direpresentasikan sebagai geometri lingkaran menggunakan titik tengah dan radius. Sampel di bawah ini ada di GeoJSON:

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

Geofence yang diunggah sebelumnya memiliki radius 100m. Permintaan di atas akan memperbaruinya menjadi 500m.

API Pembaruan Data melakukan operasi jangka panjang.

Batas Pembaruan Data

Perlu diketahui bahwa saat ini setiap akun Azure Maps memiliki batas penyimpanan data. Setelah batas penyimpanan tercapai, semua panggilan API unggahan baru akan mengembalikan 409 Conflict respons kesalahan http. Anda selalu dapat menggunakan DATA Delete API untuk menghapus konten lama/tidak digunakan dan membuat ruang untuk unggahan baru.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
geography	path	True	string	Parameter ini menentukan lokasi sumber daya Azure Maps Creator. Nilai yang valid adalah kita dan Uni Eropa.
udid	path	True	string	Id data unik untuk konten. `udid` harus diperoleh dari panggilan Pengunggahan Data yang berhasil.
api-version	query	True	string	Nomor versi API Azure Maps.
description	query		string	Deskripsi yang akan diberikan pada unggahan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Isi Permintaan

Nama	Jenis	Deskripsi
UpdateContent	object	Konten baru yang akan memperbarui/mengganti konten yang diunggah sebelumnya.

Respons

Nama	Jenis	Deskripsi
200 OK	LongRunningOperationResult	Operasi sedang berjalan atau selesai. Jika operasi berhasil, gunakan header Resource-Location untuk mendapatkan jalur ke hasilnya. Headers Resource-Location: string
202 Accepted		Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Operation-Location untuk mendapatkan status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Batas penyimpanan data tercapai pada akun Azure Maps. Anda selalu dapat menggunakan DATA Delete API untuk menghapus konten lama/tidak digunakan dan membuat ruang untuk unggahan baru.
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps .

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Create akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

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

Response Body

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
LongRunningOperationResult	Model respons untuk API Operasi Long-Running.
LroStatus	Status permintaan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

LongRunningOperationResult

Model respons untuk API Operasi Long-Running.

Nama	Jenis	Deskripsi
created	string	Tanda waktu yang dibuat.
error	ErrorDetail	Detail kesalahan.
operationId	string	Id untuk operasi jangka panjang ini.
status	LroStatus	Status permintaan.
warning	ErrorDetail	Detail kesalahan.

LroStatus

Status permintaan.

Nama	Jenis	Deskripsi
Failed	string	Permintaan memiliki satu atau beberapa kegagalan.
NotStarted	string	Permintaan belum mulai diproses.
Running	string	Permintaan telah mulai diproses.
Succeeded	string	Permintaan berhasil diselesaikan.

Share via

Data - Update

Kirim Permintaan Pembaruan

Batas Pembaruan Data

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

AADToken

Catatan

Scopes

subscription-key

SAS Token

Contoh

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

Sample Request

Sample Response

Definisi

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

Sumber Daya Tambahan: