Feature State - List Statesets

Referenz

Dienst:: Maps Creator

API-Version:: 2.0

Dient zum Abrufen einer Liste von Statesets.

Hinweis

Einstellung von Azure Maps Creator

Der Gebäudeplandienst Azure Maps Creator ist veraltet und wird am 30. September 2025 eingestellt. Weitere Informationen finden Sie unter Ankündigung zum Ende des Lebenszyklus von Azure Maps Creator.

Submit List Statesets Request

Die List Statesets-API ist eine HTTP-GET Anforderung, die verwendet wird, um eine Liste vorhandener Statesets zurückzugeben.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
geography	path	True	string	Dieser Parameter gibt an, wo sich die Azure Maps Creator-Ressource befindet. Gültige Werte sind uns und eu.
api-version	query	True	string	Versionsnummer der Azure Maps-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-id		string	Gibt an, welches Konto in Verbindung mit dem Microsoft Entra ID-Sicherheitsmodell für die Verwendung vorgesehen ist. Sie stellt eine eindeutige ID für das Azure Maps-Konto dar und kann aus der Azure Maps-Verwaltungsebenen-Konto-API abgerufen werden. Informationen zur Verwendung der Sicherheit von Microsoft Entra-ID in Azure Maps finden Sie in den folgenden Artikeln anleitungen.

Antworten

Name	Typ	Beschreibung
200 OK	StatesetListResult	Die List Stateset-Anforderung wurde erfolgreich abgeschlossen. Der Antworttext enthält eine Liste aller zuvor erstellten Statesets.
Other Status Codes	ErrorResponse	Unerwarteter Fehler.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Bei Kombination mit rollenbasierten Azure-Zugriff Steuern kann es verwendet werden, um den Zugriff auf Azure Maps-REST-APIs zu steuern. Azure-rollenbasierte Zugriffssteuerungen werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps-Ressourcenkonten oder -Unterressourcen zu bestimmen. Jedem Benutzer, Gruppen- oder Dienstprinzipal kann über eine integrierte Rolle oder eine benutzerdefinierte Rolle, die aus einer oder mehreren Berechtigungen für Azure Maps-REST-APIs besteht, Zugriff gewährt werden.

Um Szenarien zu implementieren, empfehlen wir, Authentifizierungskonzepteanzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung für die Modellierung von Anwendungen über Objekte, die zugriffsfähig für bestimmte APIs und Bereiche sind.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id-Headers, um anzugeben, auf welche Azure Maps-Ressource die Anwendung Zugriff anfordert. Dies kann über die Karten-Verwaltungs-APIerworben werden.

Die Authorization URL ist spezifisch für die Öffentliche Azure-Cloudinstanz. Souveräne Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra-ID-Konfigurationen. * Die rollenbasierte Azure-Zugriffssteuerung wird über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Weitere Informationen zur Microsoft Identity Platform finden Sie unter Übersicht über die Microsoft Identity Platform.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

subscription-key

Dies ist ein freigegebener Schlüssel, der bereitgestellt wird, wenn Sie Erstellen eines Azure Maps-Kontos im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API.

Mit diesem Schlüssel kann jede Anwendung auf alle REST-API zugreifen. Mit anderen Worten, dieser Schlüssel kann als Hauptschlüssel in dem Konto verwendet werden, in dem sie ausgestellt werden.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, die vertraulichen Clientanwendungen Ansatz für den Zugriff auf Azure Maps-REST-APIs zu verwenden, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Dies ist ein Freigegebenes Zugriffssignaturtoken wird aus dem Listen-SAS-Vorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über das Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und feinkörniger Kontrolle auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token autorisiert. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen das Steuern des Zugriffs auf eine sicherere Weise zu ermöglichen als der freigegebene Schlüssel.

Für öffentlich zugängliche Anwendungen empfiehlt es sich, eine bestimmte Liste der zulässigen Ursprünge auf der Zuordnungskontoressource zu konfigurieren,, um das Rendern von Missbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Typ: apiKey
In: header

Beispiele

List all the previously created statesets

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
BooleanRule	Die boolesche Regel. Die Farbe wird basierend auf dem Logikwert des Schlüssels ausgewählt.
BooleanStyleRule	Das boolesche Typ-Regelobjekt.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
NumberRule	Die numerische Regel. Die Farbe wird aus dem ersten Bereich ausgewählt, in den sie fällt.
NumberStyleRule	Das Regelobjekt des numerischen Typs.
Range	Der numerische Wertebereich für diese Formatvorlagenregel. Wenn sich der Wert im Bereich befindet, müssen alle Bedingungen "true" enthalten.
StatesetInfo	Das Statussatzinformationsdetails.
StatesetListResult	Das Antwortmodell für die erfolgreiche Stateset-Listen-API.
StringStyleRule	Das Regelobjekt des Zeichenfolgentyps.
StyleRules	Das Formatvorlagenmodell.

BooleanRule

Objekt

Die boolesche Regel. Die Farbe wird basierend auf dem Logikwert des Schlüssels ausgewählt.

Name	Typ	Beschreibung
false	string	Die Farbe, wenn der Wert falsch ist. Farbe ist eine JSON-Zeichenfolge in einer Vielzahl zulässiger Formate, HEX-Werte im HTML-Stil, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.
true	string	Die Farbe, wenn der Wert wahr ist. Farbe ist eine JSON-Zeichenfolge in einer Vielzahl zulässiger Formate, HEX-Werte im HTML-Stil, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.

BooleanStyleRule

Objekt

Das boolesche Typ-Regelobjekt.

Name	Typ	Beschreibung
keyName	string	Name des Stateset-Stilschlüssels. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.
rules	BooleanRule[]	Boolesche Stilregeln.
type	string: boolean	Der Typ der Stateset-Formatvorlage.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NumberRule

Objekt

Die numerische Regel. Die Farbe wird aus dem ersten Bereich ausgewählt, in den sie fällt.

Name	Typ	Beschreibung
color	string	Die Farbe, wenn sich der Wert innerhalb des Bereichs befindet. Farbe ist eine JSON-Zeichenfolge in einer Vielzahl zulässiger Formate, HEX-Werte im HTML-Stil, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.
range	Range	Der numerische Wertebereich für diese Formatvorlagenregel. Wenn sich der Wert im Bereich befindet, müssen alle Bedingungen "true" enthalten.

NumberStyleRule

Objekt

Das Regelobjekt des numerischen Typs.

Name	Typ	Beschreibung
keyName	string	Name des Stateset-Stilschlüssels. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.
rules	NumberRule[]	Regeln für numerische Formatvorlagen.
type	string: number	Der Typ der Stateset-Formatvorlage.

Range

Objekt

Der numerische Wertebereich für diese Formatvorlagenregel. Wenn sich der Wert im Bereich befindet, müssen alle Bedingungen "true" enthalten.

Name	Typ	Beschreibung
exclusiveMaximum	string	All the number x that x < exclusiveMaximum.
exclusiveMinimum	string	Alle x x > exclusiveMinimum.
maximum	string	Alle X-Werte, die x ≤ maximal.
minimum	string	Alle x x ≥ Minimum.

StatesetInfo

Objekt

Das Statussatzinformationsdetails.

Name	Typ	Beschreibung
datasetIds	string[]	Dataset-ID, die dem Stateset zugeordnet ist.
description	string	Beschreibung, die dem Stateset zugeordnet ist.
statesetId	string	Die Stateset-ID dieses Stateset-Objekts.
statesetStyle	StyleRules	Das Formatvorlagenmodell.

StatesetListResult

Objekt

Das Antwortmodell für die erfolgreiche Stateset-Listen-API.

Name	Typ	Beschreibung
nextLink	string	Wenn vorhanden, der Speicherort der nächsten Seite mit Daten.
statesets	StatesetInfo[]	Eine Liste der Statesets-Informationen.

StringStyleRule

Objekt

Das Regelobjekt des Zeichenfolgentyps.

Name	Typ	Beschreibung
keyName	string	Name des Stateset-Stilschlüssels. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.
rules	object[]	Regeln für Zeichenfolgenformatvorlagen.
type	string: string	Der Typ der Stateset-Formatvorlage.

StyleRules

Objekt

Das Formatvorlagenmodell.

Name	Typ	Beschreibung
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Ein Array von Stateset-Stilregeln. Die Formatvorlagenregel kann eine numerische oder Zeichenfolge oder eine boolesche Typ-Formatvorlagenregel sein. Informationen zu den Definitionen NumberRule, StringRule und BooleanRule hier.

Freigeben über

Feature State - List Statesets

Submit List Statesets Request

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

AADToken

Hinweise

Bereiche

subscription-key

SAS Token

Beispiele

List all the previously created statesets

Beispielanforderung

Beispiel für eine Antwort

Definitionen

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

StatesetInfo

StatesetListResult

StringStyleRule

StyleRules

Zusätzliche Ressourcen