Feature State - Create Stateset

Gunakan untuk membuat stateset baru.

Catatan

Azure Maps penghentian layanan Status Fitur Pembuat

Layanan status fitur pembuat Azure Maps sekarang tidak digunakan lagi dan akan dihentikan pada 31/3/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.

Create Stateset API adalah permintaan HTTP POST yang digunakan untuk membuat stateset baru, menentukan nilai dan gaya yang sesuai untuk propertinya dalam isi permintaan. Untuk informasi selengkapnya, lihat Create himpunan status fitur.

Layanan Status Fitur memungkinkan pengguna untuk memperbarui status fitur dan mengkuerinya untuk digunakan di layanan lain. Properti dinamis fitur yang bukan milik himpunan data disebut sebagai status di sini.

Pivot layanan Status Fitur ini pada stateset. Seperti tileset, stateset merangkum mekanisme penyimpanan untuk status fitur untuk himpunan data.

Setelah stateset dibuat, pengguna dapat menggunakannya statesetId untuk memposting pembaruan status fitur dan mengambil status fitur saat ini. Fitur hanya dapat memiliki satu status pada titik waktu tertentu.

Status fitur ditentukan oleh nama kunci, nilai, dan tanda waktu. Saat pembaruan status fitur diposting ke Azure Maps, nilai status akan diperbarui hanya jika tanda waktu status yang disediakan lebih lambat dari tanda waktu yang disimpan.

Azure Maps MapControl menyediakan cara untuk menggunakan status fitur ini untuk menata fitur. Untuk informasi selengkapnya, lihat Petak Peta Get Map State layanan Render.

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}
POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&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.

api-version
query True

string

Nomor versi API Azure Maps.

datasetId
query True

string

DatasetId harus diperoleh dari panggilan API Create Himpunan Data yang berhasil.

description
query

string

Deskripsi untuk stateset. Panjang maksimum yang diperbolehkan adalah 1000.

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
styles StyleRule[]:

Array aturan gaya stateset. Aturan gaya bisa berupa aturan gaya numerik atau string atau jenis boolean. Lihat definisi NumberRule, StringRule, dan BooleanRule di sini.

Respons

Nama Jenis Deskripsi
200 OK

StatesetCreatedResult

Stateset dibuat.

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.

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

Create a new stateset with a datasetId

Sample Request

POST https://us.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId=5d34fbe8-87b7-f7c0-3144-c50e003a3c75&description=Stateset for Azure Maps POC.

{
  "styles": [
    {
      "keyName": "s1",
      "type": "boolean",
      "rules": [
        {
          "true": "#FF0000",
          "false": "#00FF00"
        }
      ]
    },
    {
      "keyName": "s2",
      "type": "number",
      "rules": [
        {
          "range": {
            "exclusiveMaximum": "50"
          },
          "color": "#343deb"
        },
        {
          "range": {
            "minimum": "50",
            "exclusiveMaximum": "70"
          },
          "color": "#34ebb1"
        },
        {
          "range": {
            "minimum": "70",
            "exclusiveMaximum": "90"
          },
          "color": "#eba834"
        },
        {
          "range": {
            "minimum": "90"
          },
          "color": "#eb3434"
        }
      ]
    },
    {
      "keyName": "s3",
      "type": "string",
      "rules": [
        {
          "stateValue1": "#FF0000",
          "stateValue2": "#FF00AA",
          "stateValueN": "#00FF00"
        }
      ]
    }
  ]
}

Sample Response

{
  "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}

Definisi

Nama Deskripsi
BooleanRule

Aturan boolean. Warna dipilih berdasarkan nilai logika kunci.

BooleanStyleRule

Objek aturan gaya jenis 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 jenis numerik.

Range

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

StatesetCreatedResult

Model respons untuk Stateset Create 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. Color 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. Color 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 jenis 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 stateset.

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. Color 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 jenis 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 stateset.

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

StatesetCreatedResult

Model respons untuk Stateset Create API yang berhasil.

Nama Jenis Deskripsi
statesetId

string

ID untuk stateset baru yang dibuat.

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

StyleRules

Model gaya.

Nama Jenis Deskripsi
styles StyleRule[]:

Array aturan gaya stateset. Aturan gaya bisa berupa aturan gaya numerik atau string atau jenis boolean. Lihat definisi NumberRule, StringRule, dan BooleanRule di sini.