Render - Get Map State Tile
Gunakan untuk mendapatkan petak peta status dalam format vektor yang kemudian dapat digunakan untuk menampilkan informasi status fitur di peta dalam ruangan.
Get Map State Tile
API adalah permintaan HTTP GET
yang mengambil petak peta status dalam format vektor, biasanya untuk diintegrasikan ke dalam modul peta dalam ruangan kontrol peta atau SDK. Kontrol peta memanggil API ini setelah gaya dinamis diaktifkan. Untuk informasi selengkapnya, lihat Tingkat Pembesaran Tampilan dan Kisi Petak Peta.
GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. Versi saat ini adalah 2022-08-01 |
stateset
|
query | True |
string |
Id himpunan status. |
x
|
query | True |
integer int32 |
Koordinat X petak peta pada kisi zoom. Nilai harus dalam rentang [0, 2 Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak peta untuk detailnya. |
y
|
query | True |
integer int32 |
Koordinat petak peta Y pada kisi zoom. Nilai harus dalam rentang [0, 2 Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak peta untuk detailnya. |
zoom
|
query | True |
integer int32 |
Tingkat perbesar tampilan untuk petak peta yang diinginkan. Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak peta untuk detailnya. |
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. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
object |
Petak peta ini dikembalikan dari panggilan Petak Peta Dapatkan Status Peta yang berhasil Media Types: "application/vnd.mapbox-vector-tile", "application/json" Headers Content-Type: string |
Other Status Codes |
Terjadi kesalahan tak terduga. Media Types: "application/vnd.mapbox-vector-tile", "application/json" |
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 akun sumber daya atau sub-sumber daya Azure Maps. 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 pemodelan 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 meminta 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 membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.
Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, ini saat ini dapat diperlakukan sebagai kunci master ke akun tempat mereka dikeluarkan.
Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server Azure Maps REST API tempat kunci ini dapat disimpan dengan aman.
Type:
apiKey
In:
header
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 fine-grain ke kedaluwarsa, tarif, 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 spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.
Type:
apiKey
In:
header
Contoh
Successful State Tile Request
Sample Request
GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom=6&x=10&y=22&statesetId=[statesetId]
Sample Response
Content-Type: application/vnd.mapbox-vector-tile
"{file}"
Definisi
Nama | Deskripsi |
---|---|
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |