Feature State - List States

Referencia

Szolgáltatás:: Maps Creator

API-verzió:: 2.0

A használatával lekérheti egy szolgáltatás állapotadatait.

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.

Listaállapot-kérelem elküldése

Az List States API egy HTTP-kérés GET , amellyel visszaadhatja az adott állapothalmaz adott funkciójával társított aktuális állapotinformációkat.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
featureId	path	True	string	Az adott állapothalmaz egyik funkciójának azonosítója. Ha a korábbi állapothalmazban nem lett beállítva állapot a featureId azonosítóhoz, a rendszer hibás kérésre adott választ ad vissza.
geography	path	True	string	Ez a paraméter határozza meg, hogy hol található a Azure Maps Creator-erőforrás. Érvényes értékek vagyunk és eu.
statesetId	path	True	string	A létrehozott állapothalmaz-azonosító.
api-version	query	True	string	Azure Maps API verziószáma.

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.

Válaszok

Name	Típus	Description
200 OK	FeatureStatesStructure	A kérés sikeresen befejeződött.
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

Get the current states of a feature

Mintakérelem

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64/featureStates/SPC4709?api-version=2.0

Mintaválasz

Állapotkód:: 200

{
  "states": [
    {
      "keyName": "s1",
      "value": "true",
      "eventTimestamp": "2019-08-16 13:01"
    }
  ]
}

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FeatureState	Egyetlen funkcióállapot-modell.
FeatureStatesStructure	A funkció egy funkció modelljét állapotba állítja.

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.

FeatureState

Egyetlen funkcióállapot-modell.

Name	Típus	Description
eventTimestamp	string	A funkcióállapot rögzítésének érvényes időbélyege.
keyName	string	Funkcióállapot kulcsneve. A megengedett maximális hossz 1000.
value	string	A funkcióállapot értéke. A típusnak meg kell felelnie a featurestate elemhez csatolt stílusdefiníciónak. A sztringtípus maximális hossza 1024.

FeatureStatesStructure

A funkció egy funkció modelljét állapotba állítja.

Name	Típus	Description
states	FeatureState[]	A funkcióállapotok tömbje.

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