Feature State - Create Stateset

Riferimento

Servizio:: Maps Creator

Versione API:: 2.0

Usare per creare un nuovo set di stati.

Nota

ritiro Mappe di Azure servizio stato funzionalità creatore

Il servizio Mappe di Azure Stato funzionalità creatore è ora deprecato e verrà ritirato il 3/31/25. Per evitare interruzioni del servizio, interrompere l'uso dei servizi di stato delle funzionalità entro il 3/31/25. Per informazioni sullo stile delle funzionalità in tempo reale in Creator, vedere Migliorare le mappe interne con lo stile delle funzionalità della mappa in tempo reale.

L'API Create Stateset è una richiesta HTTP POST usata per creare un nuovo set di stati, definendo i valori e gli stili corrispondenti per le relative proprietà nel corpo della richiesta. Per altre informazioni, vedere Create un set di stati di funzionalità.

Il servizio Stato funzionalità consente all'utente di aggiornare gli stati di una funzionalità e di eseguirne una query in altri servizi. Le proprietà dinamiche di una funzionalità che non appartengono al set di dati sono denominate stati qui.

Questo servizio stato funzionalità pivot nel set di stati. Come il set di riquadri, il set di stati incapsula il meccanismo di archiviazione per gli stati delle funzionalità per un set di dati.

Dopo aver creato il set di stati, gli utenti possono usarli statesetId per pubblicare gli aggiornamenti dello stato delle funzionalità e recuperare gli stati di funzionalità correnti. Una funzionalità può avere uno stato solo in un determinato momento.

Lo stato della funzionalità è definito dal nome della chiave, dal valore e dal timestamp. Quando un aggiornamento dello stato della funzionalità viene pubblicato in Mappe di Azure, il valore di stato viene aggiornato solo se il timestamp dello stato specificato è successivo al timestamp archiviato.

Mappe di Azure MapControl consente di usare questi stati di funzionalità per applicare stili alle funzionalità. Per altre informazioni, vedere riquadro Get Map State (Ottieni stato mappa) dei servizi di rendering.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
geography	path	True	string	Questo parametro specifica dove si trova la risorsa Mappe di Azure Creator. I valori validi sono noi ed eu.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
datasetId	query	True	string	Il datasetId deve essere stato ottenuto da una chiamata API Create set di dati riuscita.
description	query		string	Descrizione per il set di stati. La lunghezza massima consentita è 1000.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Corpo della richiesta

Nome	Tipo	Descrizione
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Matrice di regole di stile del set di stati. La regola di stile può essere una regola di stile numerica o numerica o di tipo booleano. Fare riferimento alle definizioni NumberRule, StringRule e BooleanRule qui.

Risposte

Nome	Tipo	Descrizione
200 OK	StatesetCreatedResult	Stateset creato.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni Microsoft Entra ID. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere panoramica Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning quando si Create un account Mappe di Azure nell'portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio delle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Tipo: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenco firma di accesso condiviso nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso basati sul ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

Create a new stateset with a datasetId

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
BooleanRule	Regola booleana. Il colore viene selezionato in base al valore della logica della chiave.
BooleanStyleRule	Oggetto regola di stile del tipo booleano.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
NumberRule	Regola numerica. Il colore viene selezionato dal primo intervallo in cui rientra.
NumberStyleRule	Oggetto regola dello stile del tipo numerico.
Range	Intervallo di valori numerici per questa regola di stile. Se il valore si trova nell'intervallo, tutte le condizioni devono contenere true.
StatesetCreatedResult	Modello di risposta per l'API Stateset riuscita Create.
StringStyleRule	Oggetto regola dello stile del tipo stringa.
StyleRules	Modello di stili.

BooleanRule

Regola booleana. Il colore viene selezionato in base al valore della logica della chiave.

Nome	Tipo	Descrizione
false	string	Colore quando il valore è false. Il colore è una stringa JSON in diversi formati consentiti, valori esadecimali in stile HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%, 50%)") e HSLA("hsla(100, 50%, 50%, 1)"). Sono consentiti anche nomi di colori HTML predefiniti, come giallo e blu.
true	string	Colore quando il valore è true. Il colore è una stringa JSON in diversi formati consentiti, valori esadecimali in stile HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%, 50%)") e HSLA("hsla(100, 50%, 50%, 1)"). Sono consentiti anche nomi di colori HTML predefiniti, come giallo e blu.

BooleanStyleRule

Oggetto regola di stile del tipo booleano.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave di stile Stateset. I nomi delle chiavi sono stringhe casuali, ma devono essere univoci all'interno della matrice di stile.
rules	BooleanRule[]	Regole di stile booleano.
type	string: boolean	Tipo di stile del set di stati.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

NumberRule

Regola numerica. Il colore viene selezionato dal primo intervallo in cui rientra.

Nome	Tipo	Descrizione
color	string	Colore quando il valore si trova all'interno dell'intervallo. Il colore è una stringa JSON in diversi formati consentiti, valori esadecimali in stile HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%, 50%)") e HSLA("hsla(100, 50%, 50%, 1)"). Sono consentiti anche nomi di colori HTML predefiniti, come giallo e blu.
range	Range	Intervallo di valori numerici per questa regola di stile. Se il valore si trova nell'intervallo, tutte le condizioni devono contenere true.

NumberStyleRule

Oggetto regola dello stile del tipo numerico.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave di stile Stateset. I nomi delle chiavi sono stringhe casuali, ma devono essere univoci all'interno della matrice di stile.
rules	NumberRule[]	Regole di stile numerico.
type	string: number	Tipo di stile del set di stati.

Range

Intervallo di valori numerici per questa regola di stile. Se il valore si trova nell'intervallo, tutte le condizioni devono contenere true.

Nome	Tipo	Descrizione
exclusiveMaximum	string	Tutto il numero x < x esclusivoMaximum.
exclusiveMinimum	string	Tutto il numero x che x > exclusiveMinimum.
maximum	string	Tutto il numero x x ≤ massimo.
minimum	string	Tutto il numero x che x ≥ minimo.

StatesetCreatedResult

Modello di risposta per l'API Stateset riuscita Create.

Nome	Tipo	Descrizione
statesetId	string	ID per il nuovo set di stati creato.

StringStyleRule

Oggetto regola dello stile del tipo stringa.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave di stile Stateset. I nomi delle chiavi sono stringhe casuali, ma devono essere univoci all'interno della matrice di stile.
rules	object[]	Regole di stile stringa.
type	string: string	Tipo di stile del set di stati.

StyleRules

Modello di stili.

Nome	Tipo	Descrizione
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Matrice di regole di stile del set di stati. La regola di stile può essere una regola di stile numerica o numerica o di tipo booleano. Fare riferimento alle definizioni NumberRule, StringRule e BooleanRule qui.

Condividi tramite