Render - Get Map Tileset

Referencia

Servicio:: Maps

Versión de la API:: 2024-04-01

Use para obtener metadatos de un conjunto de iconos.

La API Get Map Tileset permite a los usuarios solicitar metadatos para un conjunto de iconos.

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Número de versión de la API de Azure Maps. La versión actual es 2024-04-01.
tilesetId	query	True	TilesetID	Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. El tilesetId para los conjuntos de iconos creados con Azure Maps Creator se generan a través de la API de creación de conjunto de iconos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base.

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 Entra de Microsoft. 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 de id. de Entra de Microsoft en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	MapTileset	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , 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 mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

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 de Azure Maps solicita acceso la aplicación. 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 id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las 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 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 crear un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

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

Tipo: apiKey
En: header

Ejemplos

Successful Tileset Request

Solicitud de ejemplo

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Respuesta de muestra

status code:: 200

{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
MapTileset	Metadatos de un conjunto de iconos en formato TileJSON.
TilesetID	Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. Los conjuntos de mosaicosetId para conjuntos de iconos creados con Azure Maps Creator se generan a través de la API De creación del conjunto de iconos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base.

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.

MapTileset

Metadatos de un conjunto de iconos en formato TileJSON.

Nombre	Tipo	Description
attribution	string	Atribución de copyright que se va a mostrar en el mapa. Las implementaciones PUEDEN decidir tratar esto como texto HTML o literal. Por motivos de seguridad, asegúrese absolutamente de que este campo no se puede abusar como vector para el seguimiento de XSS o baliza.
bounds	number[]	La extensión máxima de los iconos de mapa disponibles. Los límites DEBEN definir un área cubierta por todos los niveles de zoom. Los límites se representan en los valores de latitud y longitud WGS:84, en el orden izquierdo, inferior, derecho, superior. Los valores pueden ser enteros o números de punto flotante.
center	number[]	Ubicación predeterminada del conjunto de mosaicos con el formato [longitud, latitud, zoom]. El nivel de zoom DEBE estar entre minzoom y maxzoom. Las implementaciones pueden usar este valor para establecer la ubicación predeterminada.
data	string[]	Matriz de archivos de datos en formato GeoJSON.
description	string	Descripción del texto del conjunto de iconos. La descripción puede contener cualquier carácter legal. Las implementaciones NO DEBEN interpretar la descripción como HTML.
grids	string[]	Matriz de puntos de conexión de interactividad.
legend	string	Leyenda que se va a mostrar con el mapa. Las implementaciones PUEDEN decidir tratar esto como texto HTML o literal. Por motivos de seguridad, asegúrese absolutamente de que este campo no se puede abusar como vector para el seguimiento de XSS o baliza.
maxzoom	integer	Nivel de zoom máximo.
minzoom	integer	Nivel de zoom mínimo.
name	string	Nombre que describe el conjunto de mosaicos. El nombre puede contener cualquier carácter legal. Las implementaciones NO DEBEN interpretar el nombre como HTML.
scheme	string	Valor predeterminado: "xyz". "xyz" o "tms". Influye en la dirección y de las coordenadas del icono. Se asume el perfil global-mercator (también conocido como Mercator esférico).
template	string	Plantilla de bigote que se usará para dar formato a los datos de las cuadrículas para la interacción.
tilejson	string	Describe la versión de la especificación TileJSON implementada por este objeto JSON.
tiles	string[]	Matriz de puntos de conexión de icono. Si se especifican varios puntos de conexión, los clientes pueden usar cualquier combinación de puntos de conexión. Todos los puntos de conexión DEBEN devolver el mismo contenido para la misma dirección URL. La matriz DEBE contener al menos un punto de conexión.
version	string	Número de versión de estilo semver.org para los iconos contenidos en el conjunto de mosaicos. Cuando se introducen cambios en los iconos, la versión secundaria DEBE cambiar.

TilesetID

Un conjunto de mosaicos es una colección de datos de trama o vector divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId que se usará al realizar solicitudes. Los conjuntos de mosaicosetId para conjuntos de iconos creados con Azure Maps Creator se generan a través de la API De creación del conjunto de iconos. A continuación se enumeran los conjuntos de iconos listos para usar proporcionados por Azure Maps. Por ejemplo, microsoft.base.

Nombre	Tipo	Description
microsoft.base	string	Un mapa base es un mapa estándar que muestra carreteras, características naturales y artificiales junto con las etiquetas de esas características en un icono vectorial. Admite los niveles de zoom del 0 al 22. Formato: vector (pbf).
microsoft.base.darkgrey	string	Todas las capas con nuestro estilo gris oscuro. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.base.hybrid	string	Muestra los datos de carretera, límite y etiqueta en un icono vectorial. Admite los niveles de zoom del 0 al 22. Formato: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Datos de carretera, límite y etiqueta en nuestro estilo gris oscuro. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.base.hybrid.road	string	Datos de carretera, límite y etiqueta en nuestro estilo principal. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.base.labels	string	Muestra etiquetas para carreteras, características naturales y artificiales en un icono vectorial. Admite los niveles de zoom del 0 al 22. Formato: vector (pbf).
microsoft.base.labels.darkgrey	string	Etiquete los datos en nuestro estilo gris oscuro. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.base.labels.road	string	Etiquete los datos en nuestro estilo principal. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.base.road	string	Todas las capas con nuestro estilo principal. Admite los niveles de zoom del 0 al 22. Formato: ráster (png).
microsoft.imagery	string	Combinación de imágenes aéreas y de satélite. Solo está disponible en la SKU de precios de S1. Admite niveles de zoom de 1 a 19. Formato: ráster (jpeg).
microsoft.terra.main	string	Relieve sombreado y capas de terra. Admite niveles de zoom de 0 a 6. Formato: ráster (png).
microsoft.traffic.absolute	string	iconos de tráfico absolutos en vector
microsoft.traffic.absolute.main	string	iconos de tráfico absolutos en trama en nuestro estilo principal.
microsoft.traffic.delay	string	iconos de tráfico en vector
microsoft.traffic.delay.main	string	iconos de tráfico en trama en nuestro estilo principal
microsoft.traffic.incident	string	iconos de incidentes en vector
microsoft.traffic.reduced.main	string	mosaicos de tráfico reducidos en trama en nuestro estilo principal
microsoft.traffic.relative	string	iconos de tráfico relativos en vector
microsoft.traffic.relative.dark	string	iconos de tráfico relativos en trama en nuestro estilo oscuro.
microsoft.traffic.relative.main	string	iconos de tráfico relativos en trama en nuestro estilo principal.
microsoft.weather.infrared.main	string	Azulejos infrarrojos meteorológicos. Las imágenes de satélite infrarrojos más recientes muestran nubes por su temperatura. Para más información, consulte Cobertura de los servicios meteorológicos de Azure Maps. Para más información sobre los datos satélite devueltos, consulte Servicios meteorológicos en Azure Maps. Admite niveles de zoom de 0 a 15. Formato: ráster (png).
microsoft.weather.radar.main	string	Mosaicos de radar meteorológicos. Imágenes de radar meteorológico más recientes, incluidas áreas de lluvia, nieve, hielo y condiciones mixtas. Para más información sobre la cobertura del servicio Weather de Azure Maps, consulte Cobertura de servicios meteorológicos de Azure Maps. Para más información sobre los datos de radar, consulte Servicios meteorológicos en Azure Maps. Admite niveles de zoom de 0 a 15. Formato: ráster (png).

Compartir a través de