Tileset - List

Referensi

Service:: Maps Creator

API Version:: 2023-03-01-preview

Gunakan untuk mendapatkan daftar tileset.

Kirim Permintaan Daftar

List API adalah permintaan HTTP GET yang digunakan untuk mengambil daftar semua tileset yang ada.

GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview

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.
api-version	query	True	string	Nomor versi API Azure Maps.

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	TilesetListResult	Permintaan set petak peta daftar berhasil diselesaikan. Isi respons berisi daftar semua tileset.
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory . 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 direktori Azure Active. * 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.

Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

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 Membuat 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 diterbitkan.

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 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

Get a list of all tilesets

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "tilesets": [
    {
      "tilesetId": "{tilesetId}",
      "datasetId": "{datasetId}",
      "description": "My first tileset",
      "minZoom": 16,
      "maxZoom": 18,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ],
      "ontology": "facility-2.0",
      "tilesetConfiguration": {
        "version": 1,
        "layers": {
          "Indoor facility": {
            "minZoom": 13,
            "maxZoom": 20,
            "features": {
              "featureClasses": [
                "facility"
              ]
            }
          },
          "Indoor unit": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "unit"
              ]
            }
          }
        }
      },
      "defaultMapConfigurationId": "{defaultMapConfigurationId}"
    },
    {
      "tilesetId": "{tilesetId}",
      "datasetId": "{datasetId}",
      "description": "My second tileset",
      "minZoom": 19,
      "maxZoom": 19,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ],
      "ontology": "facility-2.0",
      "tilesetConfiguration": {
        "version": 1,
        "layers": {
          "Indoor facility": {
            "minZoom": 13,
            "maxZoom": 20,
            "features": {
              "featureClasses": [
                "facility"
              ]
            }
          },
          "Indoor unit": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "unit"
              ]
            }
          },
          "Indoor opening": {
            "minZoom": 16,
            "maxZoom": 19,
            "features": {
              "featureClasses": [
                "opening"
              ]
            }
          }
        }
      },
      "defaultMapConfigurationId": "{defaultMapConfigurationId}"
    }
  ]
}

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
Feature	Konfigurasi fitur untuk konfigurasi tileset.
LayerObject	Objek lapisan untuk konfigurasi tileset.
Tileset	Informasi detail untuk data.
TilesetConfiguration	Bidang tingkat atas konfigurasi tileset. Konfigurasi tileset adalah objek JSON yang harus berisi bidang tingkat atas berikut:
TilesetListResult	Model respons untuk Tileset List API. Mengembalikan daftar semua tileset.

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.

Feature

Konfigurasi fitur untuk konfigurasi tileset.

Nama	Jenis	Deskripsi
featureClasses	string[]	Daftar kelas fitur yang akan digunakan untuk membangun lapisan. Kelas fitur yang valid dapat ditemukan dalam definisi ontologinya. Misalnya, Ontologi Fasilitas
filter	object	Menghapus fitur yang tidak cocok dengan pola. Lihat ekspresi filter MapLibre

LayerObject

Objek lapisan untuk konfigurasi tileset.

Nama	Jenis	Deskripsi
features	Feature	Menentukan kelas dan filter fitur.
maxZoom	integer	Tingkat pembesaran tampilan tertinggi untuk lapisan yang akan dibangun.
minZoom	integer	Tingkat zoom terendah untuk lapisan yang akan dibangun.

Tileset

Informasi detail untuk data.

Nama	Jenis	Deskripsi
bbox	number[]	Kotak pembatas tempat semua fitur tileset berada. Proyeksi yang digunakan - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.
datasetId	string	Id himpunan data unik yang digunakan untuk membuat set petak peta.
defaultMapConfigurationId	string	Id konfigurasi peta yang dihasilkan default untuk tileset
description	string	Deskripsi yang diberikan pemanggil saat membuat tileset. Panjang maksimum 1024 karakter.
maxZoom	integer	Petak peta zoom peta tertinggi yang dihasilkan untuk tileset.
minZoom	integer	Petak peta zoom peta terendah yang dihasilkan untuk tileset.
ontology	string	Versi ontologi himpunan data ini.
tilesetConfiguration	TilesetConfiguration	Konfigurasi tileset yang digunakan untuk membangun tileset.
tilesetId	string	Id tileset unik untuk tileset.

TilesetConfiguration

Bidang tingkat atas konfigurasi tileset. Konfigurasi tileset adalah objek JSON yang harus berisi bidang tingkat atas berikut:

Nama	Jenis	Deskripsi
layers	<string, LayerObject>	Nama lapisan dan opsi konfigurasinya. Objek lapisan konfigurasi berisi pasangan kunci-nilai yang mengaitkan nama lapisan petak peta dengan konfigurasinya. Untuk setiap pasangan kunci-nilai, kuncinya adalah nama lapisan, dan nilainya adalah LayerObject yang berisi konfigurasi dan opsi untuk lapisan. Setiap lapisan harus memiliki nama. Ini adalah pengidentifikasi unik untuk lapisan data di tileset akhir Anda. Dalam tileset apa pun, setiap nama lapisan harus unik. Nama lapisan harus berupa string dengan hanya garis bawah (_) dan karakter alfanumerik. LayerObject yang sesuai untuk setiap nama lapisan menjelaskan bagaimana lapisan petak peta vektor tersebut harus dibuat. Ini menentukan kelas fitur mana yang akan diambil data fitur, presisi data melalui tingkat perbesar tampilan, dan cara mengubah fitur dan merendernya menjadi petak peta.
version	integer	Versi referensi konfigurasi layanan Azure Maps Tiling yang digunakan konfigurasi tileset. Saat ini hanya versi 1 yang diizinkan. Menggunakan versi apa pun lainnya versi saat ini atau versi sebelumnya akan mengakibatkan kesalahan.

TilesetListResult

Model respons untuk Tileset List API. Mengembalikan daftar semua tileset.

Nama	Jenis	Deskripsi
nextLink	string	Jika ada, lokasi halaman data berikutnya.
tilesets	Tileset[]	Daftar semua tileset.

Share via