Feature State - Get Stateset

Référence

Service:: Maps Creator

Version d'API:: 2.0

Utilisez pour récupérer des informations d’ensemble d’états.

Notes

Azure Maps Creator Feature State service mise hors service

Le service Azure Maps Creator Feature State est désormais déconseillé et sera mis hors service le 31/3/3/25. Pour éviter les interruptions de service, cessez d’utiliser les services d’état des fonctionnalités avant le 31/3/25. Pour plus d’informations sur le style des fonctionnalités en temps réel dans Creator, consultez Améliorer vos cartes d’intérieur avec le style des fonctionnalités de carte en temps réel.

L’API Get Stateset est une requête HTTP GET utilisée pour récupérer les informations d’ensemble d’états spécifiés, y compris le datasetId associé à l’ensemble d’états et ses styles.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
geography	path	True	string	Ce paramètre spécifie l’emplacement de la ressource Creator Azure Maps. Les valeurs valides sont us et eu.
statesetId	path	True	string	ID d’ensemble d’états qui a été créé.
api-version	query	True	string	Numéro de version de l’API Azure Maps.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-id		string	Spécifie quel compte est destiné à être utilisé conjointement avec le modèle de sécurité Microsoft Entra ID. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte du plan de gestion Azure Maps. Pour utiliser Microsoft Entra ID sécurité dans Azure Maps consultez les articles suivants pour obtenir des conseils.

Réponses

Nom	Type	Description
200 OK	Stateset	Obtenir la demande terminée avec succès.
Other Status Codes	ErrorResponse	Une erreur inattendue s’est produite.

Sécurité

AADToken

Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation et des configurations Microsoft Entra ID uniques. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Pour plus d’informations sur Plateforme d'identités Microsoft, consultez Plateforme d'identités Microsoft vue d’ensemble.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

subscription-key

Il s’agit d’une clé partagée qui est provisionnée lorsque vous Create un compte Azure Maps dans le Portail Azure ou à l’aide de PowerShell, de l’interface CLI, des SDK Azure ou de l’API REST.

Avec cette clé, n’importe quelle application peut accéder à toutes les API REST. En d’autres termes, cette clé peut être utilisée comme clé master dans le compte dans lequel elle est émise.

Pour les applications exposées publiquement, notre recommandation est d’utiliser l’approche des applications clientes confidentielles pour accéder à Azure Maps API REST afin que votre clé puisse être stockée en toute sécurité.

Type: apiKey
Dans: query

SAS Token

Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via Portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.

Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle de grain précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.

Pour les applications exposées publiquement, notre recommandation est de configurer une liste spécifique d’origines autorisées sur la ressource de compte Map afin de limiter les abus de rendu et de renouveler régulièrement le jeton SAP.

Type: apiKey
Dans: header

Exemples

Get stateset information with a statesetId

Exemple de requête

HTTP

GET https://us.atlas.microsoft.com/featureStateSets/b24bdb73-1305-3212-1909-a428d937b64?api-version=2.0

Exemple de réponse

Code d’état:: 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"
          }
        ]
      }
    ]
  }
}

Définitions

Nom	Description
BooleanRule	Règle booléenne. La couleur est sélectionnée en fonction de la valeur logique de la clé.
BooleanStyleRule	Objet de règle de style de type booléen.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
NumberRule	Règle numérique. La couleur est sélectionnée dans la première plage dans laquelle elle se trouve.
NumberStyleRule	Objet de règle de style de type numérique.
Range	Plage de valeurs numériques pour cette règle de style. Si la valeur se trouve dans la plage, toutes les conditions doivent avoir la valeur true.
Stateset	Modèle de réponse pour l’API Get de l’ensemble d’états réussi.
StringStyleRule	Objet de règle de style de type chaîne.
StyleRules	Modèle de styles.

BooleanRule

Règle booléenne. La couleur est sélectionnée en fonction de la valeur logique de la clé.

Nom	Type	Description
false	string	Couleur lorsque la valeur est false. La couleur est une chaîne JSON dans une variété de formats autorisés, de valeurs hexadécimale de style HTML, RVB (« #ff0 », « #ffff00 », « rgb(255, 255, 0) »), RGBA (« rgba(255, 255, 0, 1) »), HSL(« hsl(100, 50%, 50%) ») et HSLA(« hsla(100, 50%, 50%, 1) »). Les noms de couleurs HTML prédéfinis, comme le jaune et le bleu, sont également autorisés.
true	string	Couleur lorsque la valeur est true. La couleur est une chaîne JSON dans une variété de formats autorisés, de valeurs hexadécimale de style HTML, RVB (« #ff0 », « #ffff00 », « rgb(255, 255, 0) »), RGBA (« rgba(255, 255, 0, 1) »), HSL(« hsl(100, 50%, 50%) ») et HSLA(« hsla(100, 50%, 50%, 1) »). Les noms de couleurs HTML prédéfinis, comme le jaune et le bleu, sont également autorisés.

BooleanStyleRule

Objet de règle de style de type booléen.

Nom	Type	Description
keyName	string	Nom de clé de style d’ensemble d’états. Les noms de clés sont des chaînes aléatoires, mais ils doivent être uniques à l’intérieur d’un tableau de style.
rules	BooleanRule[]	Règles de style booléennes.
type	string: boolean	Type de style d’ensemble d’états.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

NumberRule

Règle numérique. La couleur est sélectionnée dans la première plage dans laquelle elle se trouve.

Nom	Type	Description
color	string	Couleur lorsque la valeur se trouve dans la plage. La couleur est une chaîne JSON dans une variété de formats autorisés, de valeurs hexadécimale de style HTML, RVB (« #ff0 », « #ffff00 », « rgb(255, 255, 0) »), RGBA (« rgba(255, 255, 0, 1) »), HSL(« hsl(100, 50%, 50%) ») et HSLA(« hsla(100, 50%, 50%, 1) »). Les noms de couleurs HTML prédéfinis, comme le jaune et le bleu, sont également autorisés.
range	Range	Plage de valeurs numériques pour cette règle de style. Si la valeur se trouve dans la plage, toutes les conditions doivent avoir la valeur true.

NumberStyleRule

Objet de règle de style de type numérique.

Nom	Type	Description
keyName	string	Nom de clé de style d’ensemble d’états. Les noms de clés sont des chaînes aléatoires, mais ils doivent être uniques à l’intérieur d’un tableau de style.
rules	NumberRule[]	Règles de style numérique.
type	string: number	Type de style d’ensemble d’états.

Range

Plage de valeurs numériques pour cette règle de style. Si la valeur se trouve dans la plage, toutes les conditions doivent avoir la valeur true.

Nom	Type	Description
exclusiveMaximum	string	Nombre x qui x < exclusiveMaximum.
exclusiveMinimum	string	Nombre x qui x > exclusiveMinimum.
maximum	string	Tous les nombres x que x ≤ maximum.
minimum	string	Tous les nombres x que x ≥ minimum.

Stateset

Modèle de réponse pour l’API Get de l’ensemble d’états réussi.

Nom	Type	Description
datasetIds	string[]	ID de jeu de données associé à l’ensemble d’états.
description	string	Description associée à l’ensemble d’états.
statesetStyle	StyleRules	Modèle de styles.

StringStyleRule

Objet de règle de style de type chaîne.

Nom	Type	Description
keyName	string	Nom de clé de style d’ensemble d’états. Les noms de clés sont des chaînes aléatoires, mais ils doivent être uniques à l’intérieur d’un tableau de style.
rules	object[]	Règles de style de chaîne.
type	string: string	Type de style d’ensemble d’états.

StyleRules

Modèle de styles.

Nom	Type	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Tableau de règles de style d’ensemble d’états. La règle de style peut être une chaîne ou une règle de style de type booléen. Reportez-vous aux définitions NumberRule, StringRule et BooleanRule ici.

Partager via

Feature State - Get Stateset

Paramètres URI

En-tête de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

subscription-key

SAS Token

Exemples

Get stateset information with a statesetId

Exemple de requête

Exemple de réponse

Définitions

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

Stateset

StringStyleRule

StyleRules

Ressources supplémentaires