Feature State - Create Stateset

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2.0

Új állapothalmaz létrehozásához használja a parancsot.

Megjegyzés

Azure Maps Creator feature State szolgáltatás kivezetése

A Azure Maps Creator feature State szolgáltatás elavult, és 2025. 03. 31-én megszűnik. A szolgáltatáskimaradások elkerülése érdekében 2025. 03. 31-ig szüntesse meg a funkcióállapot-szolgáltatások használatát. A valós idejű funkcióformázással kapcsolatos információkért lásd: Beltéri térképek továbbfejlesztése valós idejű térképfunkció-stílussal.

Az Create Stateset API egy ÚJ állapothalmaz létrehozására szolgáló HTTP-kérés POST , amely a kérelem törzsében határozza meg a tulajdonságaihoz tartozó értékeket és stílusokat. További információt a funkcióállapot-halmaz Létrehozás című témakörben talál.

A Funkcióállapot szolgáltatás lehetővé teszi, hogy a felhasználó frissítse egy szolgáltatás állapotát, és lekérdezhesse őket más szolgáltatásokban való használatukra. Az adathalmazhoz nem tartozó szolgáltatások dinamikus tulajdonságait itt állapotnak nevezzük.

Ez a szolgáltatásállapot-szolgáltatás kimutatása az állapothalmazon. A csempekészlethez hasonlóan az állapotkészlet is tartalmazza az adathalmaz funkcióállapotainak tárolási mechanizmusát.

Az állapothalmaz létrehozása után a felhasználók ezzel statesetId közzétehetik a funkcióállapot-frissítéseket, és lekérhetik az aktuális funkcióállapotokat. Egy szolgáltatás csak egy állapottal rendelkezhet egy adott időpontban.

A funkció állapotát a kulcs neve, értéke és időbélyege határozza meg. Ha a szolgáltatásállapot-frissítést Azure Maps küldi el, az állapotérték csak akkor frissül, ha a megadott állapot időbélyege későbbi, mint a tárolt időbélyeg.

Azure Maps MapControl lehetővé teszi, hogy ezeket a funkcióállapotokat a funkciók stílusához használja. További információ: Renderelési szolgáltatások – Térképállapot-csempe lekérése.

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}

Opcionális paraméterekkel:

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&description={description}

URI-paraméterek

Name	In	Kötelező	Típus	Description
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található a Azure Maps Létrehozó erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	A Azure Maps API verziószáma.
datasetId	query	True	string	Az adathalmazazonosítót egy sikeres adathalmaz-Létrehozás API-hívásból kell beszerezni.
description	query		string	Az állapothalmaz leírása. A megengedett maximális hossz 1000.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást.

Kérelem törzse

Name	Típus	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Az állapothalmaz-stílusszabályok tömbje. A stílusszabály lehet numerikus vagy sztring, vagy logikai típusú stílusszabály. A NumberRule, a StringRule és a BooleanRule definíciókat itt találja.

Válaszok

Name	Típus	Description
200 OK	StatesetCreatedResult	Létrehozott állapothalmaz.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Létrehozás egy Azure Maps fiókot a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.

Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.

Típus: apiKey
In: query

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Típus: apiKey
In: header

Példák

Create a new stateset with a datasetId

Mintakérelem

HTTP

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"
        }
      ]
    }
  ]
}

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
BooleanRule	A logikai szabály. A szín a kulcs logikai értéke alapján van kiválasztva.
BooleanStyleRule	A logikai típus stílusszabály-objektuma.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
NumberRule	A numerikus szabály. A szín az első tartományból van kiválasztva.
NumberStyleRule	A numerikus típusstílus szabályobjektuma.
Range	A stílusszabály numerikus értéktartománya. Ha az érték a tartományban van, az összes feltételnek igaznak kell lennie.
StatesetCreatedResult	A sikeres Stateset Létrehozás API válaszmodellje.
StringStyleRule	A sztringtípus stílusszabály-objektuma.
StyleRules	A stílusmodell.

BooleanRule

A logikai szabály. A szín a kulcs logikai értéke alapján van kiválasztva.

Name	Típus	Description
false	string	A szín, ha az érték hamis. A color (szín) egy JSON-sztring számos engedélyezett formátumban, HTML-stílusú hexadecimális értékekben, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), és HSLA("hsla(100, 50%, 50%, 1)"). Az előre definiált HTML-színnevek, például a sárga és a kék is engedélyezettek.
true	string	A szín, ha az érték igaz. A color (szín) egy JSON-sztring számos engedélyezett formátumban, HTML-stílusú hexadecimális értékekben, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), és HSLA("hsla(100, 50%, 50%, 1)"). Az előre definiált HTML-színnevek, például a sárga és a kék is engedélyezettek.

BooleanStyleRule

A logikai típus stílusszabály-objektuma.

Name	Típus	Description
keyName	string	Államkészlet stíluskulcsának neve. A kulcsnevek véletlenszerű sztringek, de egyedinek kell lenniük a stílustömbben.
rules	BooleanRule[]	Logikai stílusszabályok.
type	string: boolean	Az állapothalmaz-stílus típusa.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

NumberRule

A numerikus szabály. A szín az első tartományból van kiválasztva.

Name	Típus	Description
color	string	A szín, ha az érték a tartományon belül van. A color (szín) egy JSON-sztring számos engedélyezett formátumban, HTML-stílusú hexadecimális értékekben, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), és HSLA("hsla(100, 50%, 50%, 1)"). Az előre definiált HTML-színnevek, például a sárga és a kék is engedélyezettek.
range	Range	A stílusszabály numerikus értéktartománya. Ha az érték a tartományban van, az összes feltételnek igaznak kell lennie.

NumberStyleRule

A numerikus típusstílus szabályobjektuma.

Name	Típus	Description
keyName	string	Államkészlet stíluskulcsának neve. A kulcsnevek véletlenszerű sztringek, de egyedinek kell lenniük a stílustömbben.
rules	NumberRule[]	Numerikus stílusszabályok.
type	string: number	Az állapothalmaz-stílus típusa.

Range

A stílusszabály numerikus értéktartománya. Ha az érték a tartományban van, az összes feltételnek igaznak kell lennie.

Name	Típus	Description
exclusiveMaximum	string	Minden x szám, ami x < exkluzívMaximum.
exclusiveMinimum	string	Minden x szám, amit x > exkluzívMinimum.
maximum	string	Az x ≤ maximális szám.
minimum	string	Az x szám, amelyet az x ≥ minimális.

StatesetCreatedResult

A sikeres Stateset Létrehozás API válaszmodellje.

Name	Típus	Description
statesetId	string	Az új létrehozott állapothalmaz azonosítója.

StringStyleRule

A sztringtípus stílusszabály-objektuma.

Name	Típus	Description
keyName	string	Államkészlet stíluskulcsának neve. A kulcsnevek véletlenszerű sztringek, de egyedinek kell lenniük a stílustömbben.
rules	object[]	Sztringstílus-szabályok.
type	string: string	Az állapothalmaz-stílus típusa.

StyleRules

A stílusmodell.

Name	Típus	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Az állapothalmaz-stílusszabályok tömbje. A stílusszabály lehet numerikus vagy sztring, vagy logikai típusú stílusszabály. A NumberRule, a StringRule és a BooleanRule definíciókat itt találja.

Megosztás a következőn keresztül: