Feature State - List Statesets

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2.0

Az állapothalmazok listájának lekérésére használható.

Megjegyzés

Az Azure Maps Creator kivonása

Az Azure Maps Creator beltéri térképszolgáltatása elavult, és 25.09.30-án megszűnik. További információkért lásd az Azure Maps Creator élettartamának megszűnését ismertető közleményét.

Listaállapotkészletek kérésének elküldése

A List Statesets API egy HTTP-GET kérés, amely a meglévő állapothalmazok listájának visszaadására szolgál.

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

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ó az Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu.
api-version	query	True	string	Az Azure Maps API verziószáma.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Megadja, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Az Azure Maps-fiók egyedi azonosítóját jelöli, amely az Azure Maps felügyeleti sík fiók API-jából kérhető le. A Microsoft Entra ID-biztonság Azure Mapsben való használatához az alábbi cikkeket útmutatásért.

Válaszok

Name	Típus	Description
200 OK	StatesetListResult	A listaállapot-kérelem sikeresen befejeződött. A válasz törzse tartalmazza az összes korábban létrehozott állapothalmaz listáját.
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

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

Forgatókönyvek implementálásához javasoljuk, hogy tekintse meg hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást kínál az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíciós megköveteli, hogy a x-ms-client-id fejléc használatával jelezze, hogy melyik Azure Maps-erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps felügyeleti API-érhető el.

A Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra-azonosító konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés a Azure felügyeleti síkjáról van konfigurálva, az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy REST API-kon keresztül. * Az Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esethez.

További információ a Microsoft identitásplatformról: 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 Azure Maps-fiók létrehozása az Azure Portalon, 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.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy használja a bizalmas ügyfélalkalmazásokat, megközelítést az 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 a Azure Maps-erőforráson az Azure felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.

Ezzel a jogkivonattal minden alkalmazás jogosult az Azure szerepköralapú hozzáférés-vezérlőivel való hozzáférésre, valamint az adott jogkivonat lejáratának, sebességének és régióinak részletes szabályozására. Más szóval az SAS-jogkivonat segítségével az alkalmazások biztonságosabban szabályozhatják a hozzáférést, mint a megosztott kulcs.

A nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfigurálja a -fiók erőforrás- engedélyezett forrásainak listáját a renderelési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Típus: apiKey
In: header

Példák

List all the previously created statesets

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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"
              }
            ]
          }
        ]
      }
    }
  ]
}

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-objektum.
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ípus stílusszabály-objektuma.
Range	A stílusszabály numerikus értéktartománya. Ha az érték a tartományban van, az összes feltételnek igaznak kell lennie.
StatesetInfo	Az állapothalmaz adatainak részletei.
StatesetListResult	A sikeres Stateset List API válaszmodellje.
StringStyleRule	A sztringtípus stílusszabály-objektuma.
StyleRules	A stílusmodell.

BooleanRule

Objektum

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 szín egy JSON-sztring különböző engedélyezett formátumokban, HTML-stílusú hexa é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 szín egy JSON-sztring különböző engedélyezett formátumokban, HTML-stílusú hexa é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

Objektum

A logikai típusú stílusszabály-objektum.

Name	Típus	Description
keyName	string	Az á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ának típusa.

ErrorAdditionalInfo

Objektum

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 információtípus.

ErrorDetail

Objektum

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 hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

NumberRule

Objektum

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 szín egy JSON-sztring különböző engedélyezett formátumokban, HTML-stílusú hexa é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

Objektum

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

Name	Típus	Description
keyName	string	Az á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ának típusa.

Range

Objektum

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, hogy x < exkluzívMaximum.
exclusiveMinimum	string	Minden x szám, hogy x > exkluzívMinimum.
maximum	string	Minden x szám, amelyet x ≤ maximálisan.
minimum	string	Az x szám, amelyet az x ≥ minimálisan.

StatesetInfo

Objektum

Az állapothalmaz adatainak részletei.

Name	Típus	Description
datasetIds	string[]	Az állapothalmazhoz társított adathalmaz-azonosító.
description	string	Az állapothalmazhoz társított leírás.
statesetId	string	Az állapothalmaz államkészlet-azonosítója.
statesetStyle	StyleRules	A stílusmodell.

StatesetListResult

Objektum

A sikeres Stateset List API válaszmodellje.

Name	Típus	Description
nextLink	string	Ha van ilyen, a következő adatoldal helye.
statesets	StatesetInfo[]	Az állapothalmazok adatainak listája.

StringStyleRule

Objektum

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

Name	Típus	Description
keyName	string	Az á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ának típusa.

StyleRules

Objektum

A stílusmodell.

Name	Típus	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Államkészletstílus-szabályok tömbje. A stílusszabály lehet numerikus vagy sztring, vagy logikai típusú stílusszabály. Tekintse meg a NumberRule, a StringRule és a BooleanRule definíciókat, itt.

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

Feature State - List Statesets

Listaállapotkészletek kérésének elküldése

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

AADToken

Jegyzetek

Hatókörök

subscription-key

SAS Token

Példák

List all the previously created statesets

Mintakérelem

Mintaválasz

Definíciók

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

StatesetInfo

StatesetListResult

StringStyleRule

StyleRules

További források