Feature State - Get Stateset

Reference

Service:: Maps Creator

API Version:: 2.0

Slouží k načtení informací o sadě stavů.

Poznámka

Vyřazení služby stavu funkcí Azure Maps Creator

Služba stavu funkcí Azure Maps Creator je teď zastaralá a 31. 3. 25. se vyřadí z provozu. Abyste se vyhnuli přerušení služeb, přestaňte do 31. 31. 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.

Rozhraní Get Stateset API je požadavek HTTP GET , který se používá k načtení informací o zadané sadě stavů, včetně datasetId informací přidružených k sadě stavů a jejích stylů.

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}?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.
statesetId	path	True	string	ID sady stavů, které bylo vytvořeno.
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 je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích.

Odpovědi

Name	Typ	Description
200 OK	Stateset	Získání požadavku se úspěšně dokončilo.
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 složené 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 pro konkrétní rozhraní API a obory.

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. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

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ůže každá aplikace přistupovat ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve kterému je vystavený.

U veřejně vystavených aplikací doporučujeme pro přístup k Azure Maps rozhraní REST API použít 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 v Azure Maps prostředku 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 autorizaci pro přístup pomocí řízení přístupu na základě role v Azure a podrobnou kontrolu vypršení platnosti, četnosti a oblastí použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup zabezpečený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 účtu map , aby se omezilo zneužití vykreslování, a pravidelně obnovovat token SAS.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
BooleanRule	Logické pravidlo. Barva je vybrána 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	Chybová odpověď
NumberRule	Číselné pravidlo. Barva se vybere z prvního rozsahu, do něhož spadá.
NumberStyleRule	Objekt pravidla stylu číselného typu.
Range	Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, musí být splněné všechny podmínky.
Stateset	Model odpovědí pro úspěšné rozhraní API pro získání sady stavů.
StringStyleRule	Objekt pravidla stylu typu řetězec.
StyleRules	Model stylů.

BooleanRule

Logické pravidlo. Barva je vybrána 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ých hodnotách 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, například ž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ých hodnotách 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, například ž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 stylu by měly být jedinečné.
rules	BooleanRule[]	Pravidla booleovského 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	Typ další informace.

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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

NumberRule

Číselné pravidlo. Barva se vybere z prvního rozsahu, do něhož 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ých hodnotách 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, například žlutá a modrá.
range	Range	Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, musí být splněné všechny podmínky.

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 stylu by měly být jedinečné.
rules	NumberRule[]	Pravidla stylu čísel.
type	string: number	Typ stylu sady stavů.

Range

Rozsah číselných hodnot pro toto pravidlo stylu Pokud je hodnota v rozsahu, musí být splněné všechny podmínky.

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

Stateset

Model odpovědí pro úspěšné rozhraní API pro získání sady stavů.

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

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 stylu 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ů. Pravidlo stylu může být číselné nebo řetězcové nebo logické pravidlo stylu typu. Projděte si definice NumberRule, StringRule a BooleanRule.