Feature State - List Statesets

Riferimento

Servizio:: Maps Creator

Versione API:: 2.0

Usare per ottenere un elenco di set di stati.

Nota

ritiro del servizio Stato funzionalità di Mappe di Azure Creator

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

Invia richiesta di set di stati di elenco

L'API List Statesets è una richiesta HTTP GET usata per restituire un elenco di set di stati esistenti.

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

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.

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 account del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	StatesetListResult	La richiesta del set di stati di elenco è stata completata correttamente. Il corpo della risposta contiene un elenco di tutti i set di stati creati in precedenza.
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A 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 sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

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

è 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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere panoramica di 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 effettuato il provisioning quando si Create un account Mappe di Azure nel 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 alle 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 List SAS nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al 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 dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

List all the previously created statesets

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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"
              }
            ]
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
BooleanRule	Regola booleana. Il colore viene selezionato in base al valore della logica della chiave.
BooleanStyleRule	Oggetto regola di stile di tipo booleano.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di 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 è compreso nell'intervallo, tutte le condizioni devono contenere true.
StatesetInfo	Dettaglio delle informazioni sul set di stati.
StatesetListResult	Modello di risposta per l'API Elenco degli stati con esito positivo.
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 value è false. Color è 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%)") e HSLA("hsla(100, 50%, 50%, 1)"). Sono consentiti anche nomi di colori HTML predefiniti, come giallo e blu.
true	string	Colore quando value è true. Color è 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%)") e HSLA("hsla(100, 50%, 50%, 1)"). Sono consentiti anche nomi di colori HTML predefiniti, come giallo e blu.

BooleanStyleRule

Oggetto regola di stile di tipo booleano.

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

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di 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 è compreso nell'intervallo. Color è 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%)") 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 è compreso nell'intervallo, tutte le condizioni devono contenere true.

NumberStyleRule

Oggetto regola dello stile del tipo numerico.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave dello stile del set di stati. I nomi delle chiavi sono stringhe casuali, ma devono essere univoci all'interno della matrice di stili.
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 è compreso nell'intervallo, tutte le condizioni devono contenere true.

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

StatesetInfo

Dettaglio delle informazioni sul set di stati.

Nome	Tipo	Descrizione
datasetIds	string[]	ID set di dati associato al set di stati.
description	string	Descrizione associata al set di stati.
statesetId	string	ID del set di stati.
statesetStyle	StyleRules	Modello di stili.

StatesetListResult

Modello di risposta per l'API Elenco degli stati con esito positivo.

Nome	Tipo	Descrizione
nextLink	string	Se presente, la posizione della pagina successiva dei dati.
statesets	StatesetInfo[]	Elenco di informazioni sui set di stati.

StringStyleRule

Oggetto regola dello stile del tipo stringa.

Nome	Tipo	Descrizione
keyName	string	Nome della chiave dello stile del set di stati. I nomi delle chiavi sono stringhe casuali, ma devono essere univoci all'interno della matrice di stili.
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 stringa o booleana. Fare riferimento alle definizioni NumberRule, StringRule e BooleanRule qui.

Condividi tramite