Feature State - Get Stateset

Referenz

Service:: Maps Creator

API Version:: 2.0

Verwenden Sie zum Abrufen von Zustandssatzinformationen.

Hinweis

Azure Maps Creator Feature State Service wird eingestellt

Der Azure Maps Creator Feature State-Dienst ist jetzt veraltet und wird am 31.03.25 eingestellt. Um Dienstunterbrechungen zu vermeiden, stellen Sie die Verwendung der Featurestatusdienste bis zum 31.03.25 ein. Informationen zum Formatieren von Echtzeitfeatures in Creator finden Sie unter Verbessern Von Innenansichten mit Echtzeit-Kartenfeatures.

Die Get Stateset API ist eine HTTP-Anforderung GET , die zum Abrufen der angegebenen Zustandssatzinformationen verwendet wird, einschließlich der datasetId dem Stateset zugeordneten informationen und seiner Stile.

GET https://{geography}.atlas.microsoft.com/featureStateSets/{statesetId}?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 "us" und "eu".
statesetId	path	True	string	Die erstellte Zustandssatz-ID.
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 verwendet werden soll. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der Azure Maps-Verwaltungsebenen-API abgerufen werden. Informationen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Antworten

Name	Typ	Beschreibung
200 OK	Stateset	Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0-Flows. In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.

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 Kartenverwaltungs-API abgerufen werden.

ist Authorization URL spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über 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 zu Microsoft Identity Platform finden Sie unter Microsoft Identity Platform Übersicht.

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

Scopes

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

subscription-key

Dies ist ein gemeinsam verwendeter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, CLI, Azure SDKs oder REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Anders ausgedrückt: Dieser Schlüssel kann als master Schlüssel in dem Konto verwendet werden, in dem er ausgestellt wird.

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

Type: apiKey
In: query

SAS Token

Dies ist ein Shared Access Signature-Token, das aus dem Sas-Listenvorgang auf der Azure Maps-Ressource über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs erstellt wird.

Mit diesem Token ist jede Anwendung für den Zugriff mit rollenbasierten Azure-Zugriffssteuerungen und einer präzisen Steuerung des Ablaufs, der Rate und der Regionen für das jeweilige Token autorisiert. Anders ausgedrückt: Das SAS-Token kann verwendet werden, um Anwendungen die Steuerung des Zugriffs auf eine sicherere Weise zu ermöglichen als der gemeinsam genutzte Schlüssel.

Für öffentlich verfügbar gemachte Anwendungen wird empfohlen, eine bestimmte Liste der zulässigen Ursprünge in der Ressource "Konto zuordnen " zu konfigurieren, um den Renderingmissbrauch zu begrenzen und das SAS-Token regelmäßig zu erneuern.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
BooleanRule	Die boolesche Regel. Die Farbe wird basierend auf dem Logikwert des Schlüssels ausgewählt.
BooleanStyleRule	Das Boolesche Typstil-Regelobjekt.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die 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 Typstils.
Range	Der numerische Wertbereich für diese Stilregel. Wenn der Wert im Bereich liegt, müssen alle Bedingungen true enthalten.
Stateset	Das Antwortmodell für die erfolgreiche Stateset Get-API.
StringStyleRule	Das Regelobjekt des Zeichenfolgentypstils.
StyleRules	Das Formatvorlagenmodell.

BooleanRule

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 false ist. Color ist eine JSON-Zeichenfolge in einer Vielzahl von zulässigen Formaten, die im HTML-Stil als Hexadezimalwerte verwendet werden. RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.
true	string	Die Farbe, wenn der Wert true ist. Color ist eine JSON-Zeichenfolge in einer Vielzahl von zulässigen Formaten, die im HTML-Stil als Hexadezimalwerte verwendet werden. RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.

BooleanStyleRule

Das Boolesche Typstil-Regelobjekt.

Name	Typ	Beschreibung
keyName	string	Schlüsselname im Stateset-Stil. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb eines Arrays eindeutig sein.
rules	BooleanRule[]	Boolesche Stilregeln.
type	string: boolean	Der Typ des Zustandssatzstils.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

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

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NumberRule

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 der Wert innerhalb des Bereichs liegt. Color ist eine JSON-Zeichenfolge in einer Vielzahl von zulässigen Formaten, die im HTML-Stil als Hexadezimalwerte verwendet werden. RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") und HSLA("hsla(100, 50%, 1)"). Vordefinierte HTML-Farbnamen wie Gelb und Blau sind ebenfalls zulässig.
range	Range	Der numerische Wertbereich für diese Stilregel. Wenn der Wert im Bereich liegt, müssen alle Bedingungen true enthalten.

NumberStyleRule

Das Regelobjekt des numerischen Typstils.

Name	Typ	Beschreibung
keyName	string	Schlüsselname im Stateset-Stil. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb eines Arrays eindeutig sein.
rules	NumberRule[]	Numerische Stilregeln.
type	string: number	Der Typ des Zustandssatzstils.

Range

Der numerische Wertbereich für diese Stilregel. Wenn der Wert im Bereich liegt, müssen alle Bedingungen true enthalten.

Name	Typ	Beschreibung
exclusiveMaximum	string	All die Zahl x, die x < exclusiveMaximum.
exclusiveMinimum	string	All die Zahl x, die x > exclusiveMinimum.
maximum	string	All die Zahl x, die x ≤ Maximum.
minimum	string	Alle Zahlen x, die mindestens x ≥.

Stateset

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

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

StringStyleRule

Das Regelobjekt des Zeichenfolgentypstils.

Name	Typ	Beschreibung
keyName	string	Schlüsselname im Stateset-Stil. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb eines Arrays eindeutig sein.
rules	object[]	Zeichenfolgenstilregeln.
type	string: string	Der Typ des Zustandssatzstils.

StyleRules

Das Formatvorlagenmodell.

Name	Typ	Beschreibung
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Ein Array von Zustandsformatregeln. Die Stilregel kann eine numerische oder Zeichenfolge oder eine boolesche Typstilregel sein. Weitere Informationen finden Sie hier zu den Definitionen NumberRule, StringRule und BooleanRule.