Feature State - Get Stateset

Referencia

Servicio:: Maps Creator

Versión de la API:: 2.0

Use para recuperar información del conjunto de estados.

Nota:

Retirada de Azure Maps Creator

El servicio de mapa de interiores de Azure Maps Creator ya está en desuso y se retirará el 30/9/25. Para más información, vea Anuncio de fin de ciclo de vida de Azure Maps Creator.

La API de Get Stateset es una solicitud HTTP GET que se usa para recuperar la información del conjunto de estados especificado, incluido el datasetId asociado al conjunto de estados y sus estilos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
geography	path	True	string	Este parámetro especifica dónde se encuentra el recurso creator de Azure Maps. Los valores válidos son nosotros y eu.
statesetId	path	True	string	Identificador del conjunto de estados que se creó.
api-version	query	True	string	Número de versión de la API de Azure Maps.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	Stateset	Obtener la solicitud se completó correctamente.
Other Status Codes	ErrorResponse	Error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso de sdk web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Get stateset information with a statesetId

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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"
          }
        ]
      }
    ]
  }
}

Definiciones

Nombre	Description
BooleanRule	Regla booleana. El color se selecciona en función del valor lógico de la clave.
BooleanStyleRule	Objeto de regla de estilo de tipo booleano.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
NumberRule	Regla numérica. El color se selecciona en el primer intervalo en el que se encuentra.
NumberStyleRule	Objeto de regla de estilo de tipo numérico.
Range	Intervalo de valores numéricos para esta regla de estilo. Si el valor está en el intervalo, todas las condiciones deben contener true.
Stateset	Modelo de respuesta para la API Get del conjunto de estados correcto.
StringStyleRule	Objeto de regla de estilo de tipo de cadena.
StyleRules	Modelo de estilos.

BooleanRule

Object

Regla booleana. El color se selecciona en función del valor lógico de la clave.

Nombre	Tipo	Description
false	string	Color cuando el valor es false. Color es una cadena JSON en una variedad de formatos permitidos, valores hexadecimales de estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), y HSLA("hsla(100, 50%, 50%, 1)"). También se permiten nombres predefinidos de colores HTML, como amarillo y azul.
true	string	Color cuando el valor es true. Color es una cadena JSON en una variedad de formatos permitidos, valores hexadecimales de estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), y HSLA("hsla(100, 50%, 50%, 1)"). También se permiten nombres predefinidos de colores HTML, como amarillo y azul.

BooleanStyleRule

Object

Objeto de regla de estilo de tipo booleano.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo stateset. Los nombres de clave son cadenas aleatorias, pero deben ser únicos dentro de la matriz de estilos.
rules	BooleanRule[]	Reglas de estilo booleano.
type	string: boolean	Tipo de estilo de conjunto de estados.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

NumberRule

Object

Regla numérica. El color se selecciona en el primer intervalo en el que se encuentra.

Nombre	Tipo	Description
color	string	Color cuando el valor está dentro del intervalo. Color es una cadena JSON en una variedad de formatos permitidos, valores hexadecimales de estilo HTML, RGB ("#ff0", "#ffff00", "rgb(255, 255, 0)"), RGBA ("rgba(255, 255, 0, 1)"), HSL("hsl(100, 50%, 50%)"), y HSLA("hsla(100, 50%, 50%, 1)"). También se permiten nombres predefinidos de colores HTML, como amarillo y azul.
range	Range	Intervalo de valores numéricos para esta regla de estilo. Si el valor está en el intervalo, todas las condiciones deben contener true.

NumberStyleRule

Object

Objeto de regla de estilo de tipo numérico.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo stateset. Los nombres de clave son cadenas aleatorias, pero deben ser únicos dentro de la matriz de estilos.
rules	NumberRule[]	Reglas de estilo numérico.
type	string: number	Tipo de estilo de conjunto de estados.

Range

Object

Intervalo de valores numéricos para esta regla de estilo. Si el valor está en el intervalo, todas las condiciones deben contener true.

Nombre	Tipo	Description
exclusiveMaximum	string	Todo el número x que x < exclusiveMaximum.
exclusiveMinimum	string	Todo el número x que x > exclusiveMinimum.
maximum	string	Todo el número x que x ≤ máximo.
minimum	string	Todo el número x que x ≥ mínimo.

Stateset

Object

Modelo de respuesta para la API Get del conjunto de estados correcto.

Nombre	Tipo	Description
datasetIds	string[]	Identificador del conjunto de datos asociado al conjunto de estados.
description	string	Descripción asociada al conjunto de estados.
statesetStyle	StyleRules	Modelo de estilos.

StringStyleRule

Object

Objeto de regla de estilo de tipo de cadena.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo stateset. Los nombres de clave son cadenas aleatorias, pero deben ser únicos dentro de la matriz de estilos.
rules	object[]	Reglas de estilo de cadena.
type	string: string	Tipo de estilo de conjunto de estados.

StyleRules

Object

Modelo de estilos.

Nombre	Tipo	Description
styles	StyleRule[]: BooleanStyleRule[] NumberStyleRule[] StringStyleRule[]	Matriz de reglas de estilo de conjunto de estados. La regla de estilo podría ser una regla de estilo de tipo numérico o de cadena o booleana. Consulte las definiciones NumberRule, StringRule y BooleanRule aquí.

Compartir a través de

Feature State - Get Stateset

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

subscription-key

SAS Token

Ejemplos

Get stateset information with a statesetId

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BooleanRule

BooleanStyleRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

NumberRule

NumberStyleRule

Range

Stateset

StringStyleRule

StyleRules

Recursos adicionales