Feature State - List Statesets

Reference

Service:: Maps Creator

API Version:: 2.0

Slouží k získání seznamu sad stavů.

Poznámka

Vyřazení služby state funkce Azure Maps Creator

Služba Azure Maps Creator Feature State je nyní zastaralá a 31. 3. 25. Pokud chcete zabránit přerušení služeb, přestaňte do 31. 3. 25. Informace o stylu funkcí v reálném čase v Creatoru najdete v článku Vylepšení interiérových map pomocí stylů funkcí map v reálném čase.

Odeslat žádost o sady stavů seznamu

Rozhraní List Statesets API je požadavek HTTP GET , který se používá k vrácení seznamu existujících sad stavů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
geography	path	True	string	Tento parametr určuje, kde se nachází prostředek Azure Maps Creator. Platné hodnoty jsou my a eu.
api-version	query	True	string	Číslo verze rozhraní API Azure Maps.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Určuje, který účet je určen pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	StatesetListResult	Požadavek sady stavů seznamu se úspěšně dokončil. Text odpovědi obsahuje seznam všech dříve vytvořených sad stavů.
Other Status Codes	ErrorResponse	Došlo k neočekávané chybě.

Zabezpečení

AADToken

Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Jedná se o sdílený klíč, který se zřídí při Create účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.

U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.

Type: apiKey
In: query

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.

S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.

U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.

Type: apiKey
In: header

Příklady

List all the previously created statesets

Sample Request

HTTP

GET https://us.atlas.microsoft.com/featureStateSets?api-version=2.0

Sample Response

Status code:: 200

{
  "statesets": [
    {
      "statesetId": "09abcdf8-cad0-b3dd-a38f-d5ee3cff5eea",
      "description": "Stateset for Main campus.",
      "datasetIds": [
        "8d700cc7-fd2c-4e21-b402-ad3f5e524f36"
      ],
      "statesetStyle": {
        "styles": [
          {
            "keyName": "s1",
            "type": "boolean",
            "rules": [
              {
                "true": "#0FFF00",
                "false": "#00FFF0"
              }
            ]
          },
          {
            "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"
              }
            ]
          }
        ]
      }
    }
  ]
}

Definice

Name	Description
BooleanRule	Logické pravidlo. Barva se vybere na základě logické hodnoty klíče.
BooleanStyleRule	Objekt pravidla stylu logického typu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
NumberRule	Číselné pravidlo. Barva je vybrána z první oblasti, do které spadá.
NumberStyleRule	Objekt pravidla stylu číselného typu.
Range	Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, všechny podmínky musí mít hodnotu true.
StatesetInfo	Podrobnosti informací o sadě stavů
StatesetListResult	Model odpovědí pro úspěšné rozhraní API pro seznam států.
StringStyleRule	Objekt pravidla stylu typu řetězec.
StyleRules	Model stylů.

BooleanRule

Logické pravidlo. Barva se vybere na základě logické hodnoty klíče.

Name	Typ	Description
false	string	Barva, pokud je hodnota false. Color je řetězec JSON v různých povolených formátech, šestnáctkové hodnoty ve stylu HTML. RGB ("#ff0", "#ffff00", "rgb(255; 255, 0)"), RGBA ("rgba(255; 255, 0, 1)"), HSL("hsl(100; 50%, 50%)") a HSLA("hsla(100; 50%, 50%, 1)"). Povolené jsou také předdefinované názvy barev HTML, jako je žlutá a modrá.
true	string	Barva, pokud je hodnota true. Color je řetězec JSON v různých povolených formátech, šestnáctkové hodnoty ve stylu HTML. RGB ("#ff0", "#ffff00", "rgb(255; 255, 0)"), RGBA ("rgba(255; 255, 0, 1)"), HSL("hsl(100; 50%, 50%)") a HSLA("hsla(100; 50%, 50%, 1)"). Povolené jsou také předdefinované názvy barev HTML, jako je žlutá a modrá.

BooleanStyleRule

Objekt pravidla stylu logického typu.

Name	Typ	Description
keyName	string	Název klíče stylu sady stavů. Názvy klíčů jsou náhodné řetězce, ale uvnitř pole stylů by měly být jedinečné.
rules	BooleanRule[]	Logická pravidla stylu.
type	string: boolean	Typ stylu sady stavů.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

NumberRule

Číselné pravidlo. Barva je vybrána z první oblasti, do které spadá.

Name	Typ	Description
color	string	Barva, pokud je hodnota v rozsahu. Color je řetězec JSON v různých povolených formátech, šestnáctkové hodnoty ve stylu HTML. RGB ("#ff0", "#ffff00", "rgb(255; 255, 0)"), RGBA ("rgba(255; 255, 0, 1)"), HSL("hsl(100; 50%, 50%)") a HSLA("hsla(100; 50%, 50%, 1)"). Povolené jsou také předdefinované názvy barev HTML, jako je žlutá a modrá.
range	Range	Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, všechny podmínky musí mít hodnotu true.

NumberStyleRule

Objekt pravidla stylu číselného typu.

Name	Typ	Description
keyName	string	Název klíče stylu sady stavů. Názvy klíčů jsou náhodné řetězce, ale uvnitř pole stylů by měly být jedinečné.
rules	NumberRule[]	Pravidla číselného stylu.
type	string: number	Typ stylu sady stavů.

Range

Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, všechny podmínky musí mít hodnotu true.

Name	Typ	Description
exclusiveMaximum	string	Vše číslo x, které x < exclusiveMaximum.
exclusiveMinimum	string	Vše číslo x, které x > exclusiveMinimum.
maximum	string	Celé číslo x, které x ≤ maximum.
minimum	string	Všechna čísla x, která x ≥ minimum.

StatesetInfo

Podrobnosti informací o sadě stavů

Name	Typ	Description
datasetIds	string[]	ID datové sady přidružené k sadě stavů
description	string	Popis přidružený k sadě států.
statesetId	string	ID sady stavů této sady stavů.
statesetStyle	StyleRules	Model stylů.

StatesetListResult

Model odpovědí pro úspěšné rozhraní API pro seznam států.

Name	Typ	Description
nextLink	string	Pokud je k dispozici, umístění další stránky dat.
statesets	StatesetInfo[]	Seznam informací o sadách stavů.

StringStyleRule

Objekt pravidla stylu typu řetězec.

Name	Typ	Description
keyName	string	Název klíče stylu sady stavů. Názvy klíčů jsou náhodné řetězce, ale uvnitř pole stylů by měly být jedinečné.
rules	object[]	Pravidla stylu řetězců.
type	string: string	Typ stylu sady stavů.

StyleRules

Model stylů.

Name	Typ	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Pole pravidel stylu sady stavů. Pravidlem stylu může být číselné nebo řetězcové pravidlo nebo pravidlo stylu logického typu. Tady najdete definice NumberRule, StringRule a BooleanRule.