Freigeben über


Feature State - Create Stateset

Verwenden Sie, um ein neues Stateset zu erstellen.

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 Nutzung der Featurestatusdienste bis zum 31.31.25 ein. Informationen zum Echtzeit-Featurestyling in Creator finden Sie unter Verbessern Ihrer Innenkarten mit Echtzeit-Kartenfeatures.For information on real-time feature styling, see Enhance your indoor maps maps feature styling.

Die Create Stateset API ist eine HTTP-Anforderung POST , die zum Erstellen eines neuen Zustandssatzes verwendet wird und die Werte und die entsprechenden Stile für ihre Eigenschaften im Textkörper der Anforderung definiert. Weitere Informationen finden Sie unter Create eines Featurestatussatzes.

Mit dem Featurestatusdienst kann der Benutzer die Zustände eines Features aktualisieren und abfragen, um sie in anderen Diensten zu verwenden. Die dynamischen Eigenschaften eines Features, die nicht zum Dataset gehören, werden hier als Zustände bezeichnet.

Dieser Featurestatusdienst pivotet für das Stateset. Wie das Kachelset kapselt das Stateset den Speichermechanismus für Featurezustände für ein Dataset.

Nachdem das Stateset erstellt wurde, können Benutzer dies verwenden, statesetId um Featurestatusupdates zu veröffentlichen und die aktuellen Featurezustände abzurufen. Ein Feature kann zu einem bestimmten Zeitpunkt nur einen Zustand aufweisen.

Der Featurestatus wird durch den Schlüsselnamen, den Wert und den Zeitstempel definiert. Wenn ein Featurestatusupdate an Azure Maps veröffentlicht wird, wird der Zustandswert nur aktualisiert, wenn der Zeitstempel des bereitgestellten Zustands höher als der gespeicherte Zeitstempel ist.

Azure Maps MapControl bietet eine Möglichkeit, diese Featurezustände zum Formatieren der Features zu verwenden. Weitere Informationen finden Sie unter Kachel " Kartenstatus abrufen" für Renderdienste.

POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}
POST https://{geography}.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId={datasetId}&description={description}

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 wir und eu.

api-version
query True

string

Versionsnummer der Azure Maps API.

datasetId
query True

string

Die datasetId muss aus einem erfolgreichen Dataset-Create-API-Aufruf abgerufen worden sein.

description
query

string

Beschreibung für das Stateset. Die maximal zulässige Länge beträgt 1000.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-id

string

Gibt an, welches Konto für die Verwendung in Verbindung mit dem Microsoft Entra ID Sicherheitsmodell vorgesehen ist. Es stellt eine eindeutige ID für das Azure Maps-Konto dar und kann von der konto-API auf Azure Maps Verwaltungsebene abgerufen werden. Anleitungen zur Verwendung Microsoft Entra ID Sicherheit in Azure Maps finden Sie in den folgenden Artikeln.

Anforderungstext

Name Typ Beschreibung
styles StyleRule[]:

Ein Array von Zustandsformatregeln. Die Formatvorlageregel kann eine numerische oder Zeichenfolge oder eine boolesche Typstilregel sein. Lesen Sie hier die Definitionen NumberRule, StringRule und BooleanRule.

Antworten

Name Typ Beschreibung
200 OK

StatesetCreatedResult

Stateset erstellt.

Other Status Codes

ErrorResponse

Ein unerwarteter Fehler ist aufgetreten.

Sicherheit

AADToken

Dies sind die Microsoft Entra OAuth 2.0 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, 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 jedem 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.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

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.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Microsoft Entra ID Konfigurationen. * Die rollenbasierte Zugriffssteuerung in 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.

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 gemeinsam genutzter Schlüssel, der bereitgestellt wird, wenn Sie ein Azure Maps-Konto im Azure-Portal oder mithilfe von PowerShell, der CLI, Azure SDKs oder der REST-API Create.

Mit diesem Schlüssel kann jede Anwendung auf die gesamte REST-API zugreifen. Mit anderen Worten, 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 zu verwenden, um auf Azure Maps REST-APIs zuzugreifen, damit Ihr Schlüssel sicher gespeichert werden kann.

Typ: apiKey
In: query

SAS Token

Hierbei handelt es sich um 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 autorisiert, mit rollenbasierten Zugriffssteuerungen in Azure auf den Ablauf, die Rate und die Region(en) der Verwendung für das jeweilige Token zuzugreifen. Mit anderen Worten, das SAS-Token kann verwendet werden, um Anwendungen zu ermöglichen, den Zugriff auf eine sicherere Weise als der freigegebene Schlüssel zu steuern.

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

Typ: apiKey
In: header

Beispiele

Create a new stateset with a datasetId

Beispielanforderung

POST https://us.atlas.microsoft.com/featureStateSets?api-version=2.0&datasetId=5d34fbe8-87b7-f7c0-3144-c50e003a3c75&description=Stateset for Azure Maps POC.

{
  "styles": [
    {
      "keyName": "s1",
      "type": "boolean",
      "rules": [
        {
          "true": "#FF0000",
          "false": "#00FF00"
        }
      ]
    },
    {
      "keyName": "s2",
      "type": "number",
      "rules": [
        {
          "range": {
            "exclusiveMaximum": "50"
          },
          "color": "#343deb"
        },
        {
          "range": {
            "minimum": "50",
            "exclusiveMaximum": "70"
          },
          "color": "#34ebb1"
        },
        {
          "range": {
            "minimum": "70",
            "exclusiveMaximum": "90"
          },
          "color": "#eba834"
        },
        {
          "range": {
            "minimum": "90"
          },
          "color": "#eb3434"
        }
      ]
    },
    {
      "keyName": "s3",
      "type": "string",
      "rules": [
        {
          "stateValue1": "#FF0000",
          "stateValue2": "#FF00AA",
          "stateValueN": "#00FF00"
        }
      ]
    }
  ]
}

Beispiel für eine Antwort

{
  "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f"
}

Definitionen

Name Beschreibung
BooleanRule

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

BooleanStyleRule

Das Boolesche Stilregelobjekt.

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 Formatregelobjekt des numerischen Typs.

Range

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

StatesetCreatedResult

Das Antwortmodell für das erfolgreiche Stateset Create-API.

StringStyleRule

Das Zeichenfolgentyp-Stilregelobjekt.

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 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 true ist. Color 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

Das Boolesche Stilregelobjekt.

Name Typ Beschreibung
keyName

string

Schlüsselname im Stateset-Format. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.

rules

BooleanRule[]

Boolesche Stilregeln.

type string:

boolean

Der Typ des Stateset-Stils.

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 sich der Wert innerhalb des Bereichs befindet. Color 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 Wertbereich für diese Formatregel. Wenn sich der Wert im Bereich befindet, müssen alle Bedingungen true enthalten.

NumberStyleRule

Das Formatregelobjekt des numerischen Typs.

Name Typ Beschreibung
keyName

string

Schlüsselname im Stateset-Format. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.

rules

NumberRule[]

Numerische Stilregeln.

type string:

number

Der Typ des Stateset-Stils.

Range

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

Name Typ Beschreibung
exclusiveMaximum

string

Die ganze Zahl x, die x < exclusiveMaximum.

exclusiveMinimum

string

Die ganze Zahl x, die x > exclusiveMinimum.

maximum

string

Die ganze Zahl x, die x ≤ maximal.

minimum

string

All die Zahl x, die x ≥ Minimum.

StatesetCreatedResult

Das Antwortmodell für das erfolgreiche Stateset Create-API.

Name Typ Beschreibung
statesetId

string

Die ID für das neu erstellte Statuset.

StringStyleRule

Das Zeichenfolgentyp-Stilregelobjekt.

Name Typ Beschreibung
keyName

string

Schlüsselname im Stateset-Format. Schlüsselnamen sind zufällige Zeichenfolgen, sollten aber innerhalb des Stilarrays eindeutig sein.

rules

object[]

Zeichenfolgenstilregeln.

type string:

string

Der Typ des Stateset-Stils.

StyleRules

Das Formatvorlagenmodell.

Name Typ Beschreibung
styles StyleRule[]:

Ein Array von Zustandsformatregeln. Die Formatvorlageregel kann eine numerische oder Zeichenfolge oder eine boolesche Typstilregel sein. Lesen Sie hier die Definitionen NumberRule, StringRule und BooleanRule.