Tileset - Get Configuration

Referencia

Service:: Maps Creator

API Version:: 2023-03-01-preview

Use para obtener una configuración de conjunto de iconos.

La solicitud Tileset Get Configuration permite al autor de la llamada obtener una configuración de conjunto de iconos en función del conjunto de datos proporcionado. Después, la configuración del conjunto de iconos se puede usar para crear un conjunto de mosaicos personalizado mediante Tileset Create.

Creator permite desarrollar aplicaciones basadas en los datos privados del mapa interior mediante Azure Maps API y SDK. Para obtener más información sobre los conceptos y herramientas que se aplican a Azure Maps Creator, consulte Creator for indoor maps(Creador para mapas interiores).

Enviar solicitud de configuración Get

La Get Configuration API es una solicitud HTTP GET que se usa para obtener una configuración de conjunto de iconos basada en "datasetId".

GET https://{geography}.atlas.microsoft.com/tilesets:fetchConfiguration?api-version=2023-03-01-preview&datasetId={datasetId}

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.
api-version	query	True	string	Número de versión de la API de Azure Maps.
datasetId	query	True	string	`datasetId` Único que usa la API de creación del conjunto de mosaicos para recuperar características para generar iconos. Debe `datasetId` haberse obtenido de una llamada API de creación correcta del conjunto de datos .

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	TilesetConfiguration	Obtener la solicitud de configuración del conjunto de iconos se completó correctamente. El cuerpo de la respuesta contiene una configuración de conjunto de iconos predeterminada generada para el conjunto de datos especificado.
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . 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. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso 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 el modelado de 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 Azure Active Directory. * 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.

Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.

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 crear 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 trata de un token de firma de acceso compartido que se crea 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 roles de Azure y al control específico de 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 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 mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Gets the tileset configuration for a given dataset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets:fetchConfiguration?api-version=2023-03-01-preview&datasetId=[datasetId]

Sample Response

Status code:: 200

{
  "version": 1,
  "layers": {
    "Indoor unit": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit",
          "wall"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "roomType"
            ],
            "conference"
          ],
          [
            ">=",
            [
              "zoom"
            ],
            12
          ]
        ]
      }
    }
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Feature	Configuración de características para la configuración del conjunto de iconos.
LayerObject	Objeto layer para la configuración del conjunto de mosaicos.
TilesetConfiguration	Campos de nivel superior de configuración del conjunto de iconos. Una configuración del conjunto de iconos es un objeto JSON que debe contener los siguientes campos de nivel superior:

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.

Feature

Configuración de características para la configuración del conjunto de iconos.

Nombre	Tipo	Description
featureClasses	string[]	Lista de clases de características que se usarán para crear la capa. Las clases de características válidas se pueden encontrar en su definición de ontología. Por ejemplo, Ontología de instalaciones
filter	object	Quita las características que no coinciden con un patrón. Consulte la expresión de filtro MapLibre.

LayerObject

Objeto layer para la configuración del conjunto de mosaicos.

Nombre	Tipo	Description
features	Feature	Especifica las clases y filtros de características.
maxZoom	integer	Nivel de zoom más alto para la capa que se va a compilar.
minZoom	integer	Nivel de zoom más bajo para la capa que se va a compilar.

TilesetConfiguration

Campos de nivel superior de configuración del conjunto de iconos. Una configuración del conjunto de iconos es un objeto JSON que debe contener los siguientes campos de nivel superior:

Nombre	Tipo	Description
layers	<string, LayerObject>	Nombres de las capas y sus opciones de configuración. El objeto de capas de configuración contiene pares clave-valor que asocian los nombres de las capas de mosaico con su configuración. Para cada par clave-valor, la clave es el nombre de la capa y el valor es un LayerObject que contiene la configuración y las opciones de la capa. Cada capa debe tener un nombre. Este es el identificador único de la capa de datos del conjunto de mosaicos final. En cualquier conjunto de mosaicos, cada nombre de capa debe ser único. El nombre de la capa debe ser una cadena con solo caracteres de subrayado (_) y alfanuméricos. El LayerObject correspondiente para cada nombre de capa describe cómo se debe crear esa capa de mosaico vectorial. Especifica qué clases de características recuperar datos de características, la precisión de los datos a través de los niveles de zoom y cómo transformar las características y representarlas en iconos.
version	integer	La versión de Azure Maps referencia de configuración del servicio Tiling que usa la configuración del conjunto de iconos. Actualmente solo se permite la versión 1. El uso de cualquier otra versión de la versión actual o una versión anterior producirá un error.

Share via