Feature State - Get Stateset

Referensi

Service:: Maps Creator

API Version:: 2.0

Gunakan untuk mengambil informasi himpunan status.

Catatan

penghentian layanan Status Fitur Pembuat Azure Maps

Layanan Azure Maps Creator Feature State sekarang tidak digunakan lagi dan akan dihentikan pada 3/31/25. Untuk menghindari gangguan layanan, berhenti gunakan layanan Status Fitur dengan 3/31/25. Untuk informasi tentang gaya fitur real time di Creator, lihat Meningkatkan peta dalam ruangan Anda dengan gaya fitur peta real-time.

Get Stateset API adalah permintaan HTTP GET yang digunakan untuk mengambil informasi himpunan status yang ditentukan, termasuk yang datasetId terkait dengan himpunan status, dan gayanya.

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}?api-version=2.0

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.
statesetId	path	True	string	Id stateset yang dibuat.
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	Stateset	Mendapatkan permintaan berhasil diselesaikan.
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 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 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 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 stateset information with a statesetId

Sample Request

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64?api-version=2.0

Sample Response

Status code:: 200

{
  "description": "Stateset for Azure Maps POC.",
  "datasetIds": [
    "8d700cc7-fd2c-4e21-b402-ad3f5e524f36"
  ],
  "statesetStyle": {
    "styles": [
      {
        "keyName": "s1",
        "type": "boolean",
        "rules": [
          {
            "true": "#FFFF00",
            "false": "#FFFFFF"
          }
        ]
      },
      {
        "keyName": "s2",
        "type": "number",
        "rules": [
          {
            "range": {
              "minimum": null,
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "50"
            },
            "color": "#343deb"
          },
          {
            "range": {
              "minimum": "50",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "69"
            },
            "color": "#34ebb1"
          },
          {
            "range": {
              "minimum": "69",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": "90"
            },
            "color": "#eba834"
          },
          {
            "range": {
              "minimum": "90",
              "maximum": null,
              "exclusiveMinimum": null,
              "exclusiveMaximum": null
            },
            "color": "#eb3434"
          }
        ]
      }
    ]
  }
}

Definisi

Nama	Deskripsi
BooleanRule	Aturan boolean. Warna dipilih berdasarkan nilai logika kunci.
BooleanStyleRule	Objek aturan gaya tipe boolean.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
NumberRule	Aturan numerik. Warna dipilih dari rentang pertama yang dijatuhkannya.
NumberStyleRule	Objek aturan gaya tipe numerik.
Range	Rentang nilai numerik untuk aturan gaya ini. Jika nilai berada dalam rentang, semua kondisi harus bernilai true.
Stateset	Model respons untuk Stateset Get API yang berhasil.
StringStyleRule	Objek aturan gaya jenis string.
StyleRules	Model gaya.

BooleanRule

Aturan boolean. Warna dipilih berdasarkan nilai logika kunci.

Nama	Jenis	Deskripsi
false	string	Warna saat nilai salah. Warna adalah string JSON dalam berbagai format yang diizinkan, nilai heksa gaya HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), dan HSLA("hsla(100, 50%, 50%, 1)"). Nama warna HTML yang telah ditentukan sebelumnya, seperti kuning dan biru, juga diizinkan.
true	string	Warna saat nilai benar. Warna adalah string JSON dalam berbagai format yang diizinkan, nilai heksa gaya HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), dan HSLA("hsla(100, 50%, 50%, 1)"). Nama warna HTML yang telah ditentukan sebelumnya, seperti kuning dan biru, juga diizinkan.

BooleanStyleRule

Objek aturan gaya tipe boolean.

Nama	Jenis	Deskripsi
keyName	string	Nama kunci gaya himpunan status. Nama kunci adalah string acak tetapi harus unik di dalam array gaya.
rules	BooleanRule[]	Aturan gaya Boolean.
type	string: boolean	Jenis gaya himpunan status.

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.

NumberRule

Aturan numerik. Warna dipilih dari rentang pertama yang dijatuhkannya.

Nama	Jenis	Deskripsi
color	string	Warna saat nilai berada dalam rentang. Warna adalah string JSON dalam berbagai format yang diizinkan, nilai heksa gaya HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), dan HSLA("hsla(100, 50%, 50%, 1)"). Nama warna HTML yang telah ditentukan sebelumnya, seperti kuning dan biru, juga diizinkan.
range	Range	Rentang nilai numerik untuk aturan gaya ini. Jika nilai berada dalam rentang, semua kondisi harus bernilai true.

NumberStyleRule

Objek aturan gaya tipe numerik.

Nama	Jenis	Deskripsi
keyName	string	Nama kunci gaya himpunan status. Nama kunci adalah string acak tetapi harus unik di dalam array gaya.
rules	NumberRule[]	Aturan gaya numerik.
type	string: number	Jenis gaya himpunan status.

Range

Rentang nilai numerik untuk aturan gaya ini. Jika nilai berada dalam rentang, semua kondisi harus bernilai true.

Nama	Jenis	Deskripsi
exclusiveMaximum	string	Semua angka x yang x < exclusiveMaximum.
exclusiveMinimum	string	Semua angka x yang x > exclusiveMinimum.
maximum	string	Semua angka x yang x ≤ maksimum.
minimum	string	Semua angka x yang x ≥ minimum.

Stateset

Model respons untuk Stateset Get API yang berhasil.

Nama	Jenis	Deskripsi
datasetIds	string[]	ID himpunan data yang terkait dengan himpunan status.
description	string	Deskripsi yang terkait dengan stateset.
statesetStyle	StyleRules	Model gaya.

StringStyleRule

Objek aturan gaya jenis string.

Nama	Jenis	Deskripsi
keyName	string	Nama kunci gaya himpunan status. Nama kunci adalah string acak tetapi harus unik di dalam array gaya.
rules	object[]	Aturan gaya string.
type	string: string	Jenis gaya himpunan status.

StyleRules

Model gaya.

Nama	Jenis	Deskripsi
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Array aturan gaya stateset. Aturan gaya bisa berupa aturan gaya numerik atau string atau tipe boolean. Lihat definisi NumberRule, StringRule, dan BooleanRule di sini.

Feature State - Get Stateset

Parameter URI

Header Permintaan

Respons

Keamanan

AADToken

Catatan

Scopes

subscription-key

SAS Token

Contoh

Get stateset information with a statesetId

Sample Request

Sample Response

Definisi

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

Stateset

StringStyleRule

StyleRules

Sumber Daya Tambahan: