Feature State - Get Stateset

Referencia

Service:: Maps Creator

API Version:: 2.0

Use para recuperar información del conjunto de estados.

Nota

Retirada del servicio de estado de características de Azure Maps Creator

El servicio Azure Maps Estado de características de Creator ya está en desuso y se retirará el 31/31/25. Para evitar interrupciones del servicio, suspenda el uso de los servicios de estado de características del 3/31/25. Para obtener información sobre el estilo de características en tiempo real en Creator, consulte Mejorar los mapas interiores con estilo de características de mapa en tiempo real.

La Get Stateset API 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 Azure Maps Creator. 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 Microsoft Entra ID. 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 Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	Stateset	Obtener la solicitud se completó correctamente.
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

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

Para implementar escenarios, se recomienda ver los 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 x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

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 Microsoft Entra ID. * 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, CLI, SDK de Azure o API REST. * El uso del 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 Plataforma de identidad de Microsoft, consulte introducción a Plataforma de identidad de Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Se trata de una clave compartida que se aprovisiona al Create una cuenta de Azure Maps en el 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.

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

Type: apiKey
In: 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 está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen 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 la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Get stateset information with a statesetId

Sample Request

HTTP

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

Sample Response

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 cae.
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

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 diversos 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 de colores HTML predefinidos, como amarillo y azul.
true	string	Color cuando el valor es true. Color es una cadena JSON en diversos 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 de colores HTML predefinidos, como amarillo y azul.

BooleanStyleRule

Objeto de regla de estilo de tipo booleano.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo de conjunto de estados. 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

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

Detalle del error.

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

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

NumberRule

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

Nombre	Tipo	Description
color	string	Color cuando el valor está dentro del intervalo. Color es una cadena JSON en diversos 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 de colores HTML predefinidos, 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

Objeto de regla de estilo de tipo numérico.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo de conjunto de estados. 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

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

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

Objeto de regla de estilo de tipo de cadena.

Nombre	Tipo	Description
keyName	string	Nombre de clave de estilo de conjunto de estados. 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

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 numérica o de cadena o una regla de estilo de tipo booleano. Consulte las definiciones NumberRule, StringRule y BooleanRule aquí.

Share via