Feature State - Create Stateset

Referentie

Service:: Maps Creator

API-versie:: 2.0

Gebruik om een nieuwe statusset te maken.

Notitie

buitengebruikstelling van Azure Maps Creator Feature State Service

De service Azure Maps Creator Feature State is nu afgeschaft en wordt op 31-3-25 buiten gebruik gesteld. Om serviceonderbrekingen te voorkomen, stopt u het gebruik van de functiestatusservices voor 31-3-25. Zie Uw plattegronden verbeteren met de stijl van realtime kaartfuncties voor informatie over de stijl van realtime functies in Creator.

De Create Stateset API is een HTTP-aanvraag POST die wordt gebruikt om een nieuwe statusset te maken, waarbij de waarden en bijbehorende stijlen voor de eigenschappen in de hoofdtekst van de aanvraag worden gedefinieerd. Zie een functiestatusset Creatie voor meer informatie.

Met de functiestatusservice kan de gebruiker de statussen van een functie bijwerken en er query's op uitvoeren voor gebruik in andere services. De dynamische eigenschappen van een functie die niet tot de gegevensset behoren, worden hier statussen genoemd.

Deze functiestatusservice draait op de statusset. Net als tegelset omvat de statusset het opslagmechanisme voor functiestatussen voor een gegevensset.

Zodra de statusset is gemaakt, kunnen gebruikers deze statesetId gebruiken om updates voor de functiestatus te posten en de huidige functiestatussen op te halen. Een functie kan slechts één status op een bepaald moment hebben.

De functiestatus wordt gedefinieerd door de sleutelnaam, de waarde en het tijdstempel. Wanneer een functiestatusupdate wordt gepost naar Azure Maps, wordt de statuswaarde alleen bijgewerkt als de tijdstempel van de opgegeven status later is dan de opgeslagen tijdstempel.

Azure Maps MapControl biedt een manier om deze functiestatussen te gebruiken om de functies op te maken. Zie de tegel Renderservices Get Map State (Kaartstatus ophalen) voor meer informatie.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
geography	path	True	string	Deze parameter geeft aan waar de resource Azure Maps Creator zich bevindt. Geldige waarden zijn wij en eu.
api-version	query	True	string	Versienummer van Azure Maps API.
datasetId	query	True	string	De datasetId moet zijn verkregen uit een geslaagde Dataset Creatie API-aanroep.
description	query		string	Beschrijving voor de statusset. De maximale toegestane lengte is 1000.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-id		string	Hiermee geeft u op welk account is bedoeld voor gebruik in combinatie met het Microsoft Entra ID-beveiligingsmodel. Het vertegenwoordigt een unieke id voor het Azure Maps-account en kan worden opgehaald uit de Azure Maps beheervlak Account-API. Als u Microsoft Entra ID beveiliging wilt gebruiken in Azure Maps raadpleegt u de volgende artikelen voor hulp.

Aanvraagbody

Name	Type	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Een matrix met regels voor de stijl van de statusset. De stijlregel kan een numerieke of tekenreeks of een booleaanse stijlregel zijn. Raadpleeg hier de definities NumberRule, StringRule en BooleanRule.

Antwoorden

Name	Type	Description
200 OK	StatesetCreatedResult	Statusset gemaakt.
Other Status Codes	ErrorResponse	Er is een onverwachte fout opgetreden.

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0-stromen. Wanneer het is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure, kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Voor deze beveiligingsdefinitie is het gebruik van de x-ms-client-id header vereist om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Kaarten-beheer-API.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Microsoft Entra ID configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksvoorbeelden.

Zie overzicht van Microsoft identity platform voor meer informatie over Microsoft identity platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

subscription-key

Dit is een gedeelde sleutel die wordt ingericht wanneer u een Azure Maps-account Creatie in de Azure Portal of met behulp van PowerShell, CLI, Azure SDK's of REST API.

Met deze sleutel heeft elke toepassing toegang tot alle REST API's. Met andere woorden, deze sleutel kan worden gebruikt als een hoofdsleutel in het account waarin ze zijn uitgegeven.

Voor openbaar beschikbare toepassingen wordt aanbevolen om de benadering van vertrouwelijke clienttoepassingen te gebruiken voor toegang tot Azure Maps REST API's, zodat uw sleutel veilig kan worden opgeslagen.

Type: apiKey
In: query

SAS Token

Dit is een Shared Access Signature-token dat is gemaakt op basis van de SAS-bewerking List op de Azure Maps resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd om toegang te krijgen met op rollen gebaseerd toegangsbeheer van Azure en fijnmazige controle tot de vervaldatum, frequentie en gebruiksregio(s) voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen in staat te stellen toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar beschikbaar gemaakte toepassingen wordt aanbevolen om een specifieke lijst met toegestane origins te configureren voor de resource van het kaartaccount om misbruik van rendering te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Create a new stateset with a datasetId

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
BooleanRule	De Booleaanse regel. De kleur wordt geselecteerd op basis van de logische waarde van de sleutel.
BooleanStyleRule	Het regelobject van het booleaanse type.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
NumberRule	De numerieke regel. De kleur wordt geselecteerd in het eerste bereik.
NumberStyleRule	Het regelobject voor de numerieke typestijl.
Range	Het numerieke waardebereik voor deze stijlregel. Als de waarde zich in het bereik bevindt, moeten alle voorwaarden waar zijn.
StatesetCreatedResult	Het antwoordmodel voor de geslaagde Statusset Creatie API.
StringStyleRule	Het tekenreekstypestijlregelobject.
StyleRules	Het stijlenmodel.

BooleanRule

De Booleaanse regel. De kleur wordt geselecteerd op basis van de logische waarde van de sleutel.

Name	Type	Description
false	string	De kleur wanneer de waarde onwaar is. Color is een JSON-tekenreeks in verschillende toegestane indelingen, hexwaarden in HTML-stijl, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") en HSLA("hsla(100, 50%, 50%, 1)"). Vooraf gedefinieerde HTML-kleurennamen, zoals geel en blauw, zijn ook toegestaan.
true	string	De kleur wanneer de waarde waar is. Color is een JSON-tekenreeks in verschillende toegestane indelingen, hexwaarden in HTML-stijl, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") en HSLA("hsla(100, 50%, 50%, 1)"). Vooraf gedefinieerde HTML-kleurennamen, zoals geel en blauw, zijn ook toegestaan.

BooleanStyleRule

Het regelobject van het booleaanse type.

Name	Type	Description
keyName	string	Sleutelnaam van de statussetstijl. Sleutelnamen zijn willekeurige tekenreeksen, maar ze moeten uniek zijn binnen de stijlmatrix.
rules	BooleanRule[]	Booleaanse stijlregels.
type	string: boolean	Het type statussetstijl.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

NumberRule

De numerieke regel. De kleur wordt geselecteerd in het eerste bereik.

Name	Type	Description
color	string	De kleur wanneer de waarde binnen het bereik ligt. Color is een JSON-tekenreeks in verschillende toegestane indelingen, hexwaarden in HTML-stijl, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)") en HSLA("hsla(100, 50%, 50%, 1)"). Vooraf gedefinieerde HTML-kleurennamen, zoals geel en blauw, zijn ook toegestaan.
range	Range	Het numerieke waardebereik voor deze stijlregel. Als de waarde zich in het bereik bevindt, moeten alle voorwaarden waar zijn.

NumberStyleRule

Het regelobject voor de numerieke typestijl.

Name	Type	Description
keyName	string	Sleutelnaam van de statussetstijl. Sleutelnamen zijn willekeurige tekenreeksen, maar ze moeten uniek zijn binnen de stijlmatrix.
rules	NumberRule[]	Regels voor numerieke stijl.
type	string: number	Het type statussetstijl.

Range

Het numerieke waardebereik voor deze stijlregel. Als de waarde zich in het bereik bevindt, moeten alle voorwaarden waar zijn.

Name	Type	Description
exclusiveMaximum	string	Al het getal x dat x < exclusiefMaximum.
exclusiveMinimum	string	Al het getal x dat x > exclusiveMinimum.
maximum	string	Alle getallen x die x ≤ maximum.
minimum	string	Alle getallen x die x ≥ minimum.

StatesetCreatedResult

Het antwoordmodel voor de geslaagde Statusset Creatie API.

Name	Type	Description
statesetId	string	De id voor de nieuwe statusset die is gemaakt.

StringStyleRule

Het tekenreekstypestijlregelobject.

Name	Type	Description
keyName	string	Sleutelnaam van de statussetstijl. Sleutelnamen zijn willekeurige tekenreeksen, maar ze moeten uniek zijn binnen de stijlmatrix.
rules	object[]	Tekenreeksstijlregels.
type	string: string	Het type statussetstijl.

StyleRules

Het stijlenmodel.

Name	Type	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Een matrix met regels voor de stijl van de statusset. De stijlregel kan een numerieke of tekenreeks of een booleaanse stijlregel zijn. Raadpleeg hier de definities NumberRule, StringRule en BooleanRule.

Delen via