Render - Get Map Tileset

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 {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

api-version
query True

string

minLength: 1

Versión de API que se usará para esta operación.

tilesetId
query True

TilesetID

Un conjunto de mosaicos es una colección de datos ráster o vectoriales divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId usar al realizar solicitudes. Los tilesets listos para usar proporcionados por Azure Maps se listan a continuación. Por ejemplo, microsoft.base.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps.

Respuestas

Nombre Tipo Description
200 OK

MapTileset

La solicitud se ha realizado correctamente.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

AadToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para Azure Maps APIs REST.\n\nPara implementar escenarios, recomendamos consultar conceptos autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones(es) mediante objetos capaces de control de acceso en APIs y ámbitos específicos.\n\n#### Notas\n* Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso Azure Maps solicita acceso la aplicación. Esto puede obtenerse de la API de gestión Maps.\n* \nEl Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. \n* \nEl control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n* \nUso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.\n* Para más información sobre Plataforma de identidad de Microsoft, véase Plataforma de identidad de Microsoft visión general.

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

subscription-key

Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, SDK de Azure o REST API.\n\n Con esta clave, cualquier aplicación puede acceder a toda la API REST. En otras palabras, esta clave puede usarse como una llave maestra en la cuenta en la que se emiten.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque confidenciales para acceder a Azure Maps APIs REST y así almacenar tu clave de forma segura.

Tipo: apiKey
En: header

SAS Token

Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n\n Con este token, cualquier aplicación está autorizada para acceder con Azure controles de acceso basados en roles y control detallado de la expiración, tasa y región(es) de uso para el token en particular. En otras palabras, el Token SAS puede usarse para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta Map para limitar el abuso de renderizado y renovar regularmente el Token SAS.

Tipo: apiKey
En: header

Ejemplos

Successful Tileset Request

Solicitud de ejemplo

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

Respuesta de muestra

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

Definiciones

Nombre Description
ErrorAdditionalInfo

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

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

MapTileset

Metadatos de un conjunto de iconos en formato TileJSON.

TilesetID

Un conjunto de mosaicos es una colección de datos ráster o vectoriales divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId usar al realizar solicitudes. Los tilesets listos para usar proporcionados por Azure Maps se listan a continuación. Por ejemplo, microsoft.base.

ErrorAdditionalInfo

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

Nombre Tipo Description
info

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[]

Detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

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[] (float)

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[] (float)

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 (int32)

minimum: 0
maximum: 30

Nivel máximo de zoom.

minzoom

integer (int32)

minimum: 0
maximum: 30

Nivel de zoom mínimo.

name

string

Nombre que describe el conjunto de iconos. 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 va a usar para dar formato a los datos de las cuadrículas para la interacción.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Describe la versión de la especificación TileJSON que implementa 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

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Número de versión de estilo semver.org para los iconos contenidos en el conjunto de iconos. Cuando se introducen cambios en los iconos, la versión secundaria DEBE cambiar.

TilesetID

Un conjunto de mosaicos es una colección de datos ráster o vectoriales divididos en una cuadrícula uniforme de mosaicos cuadrados en niveles de zoom preestablecidos. Cada conjunto de iconos tiene un tilesetId usar al realizar solicitudes. Los tilesets listos para usar proporcionados por Azure Maps se listan a continuación. Por ejemplo, microsoft.base.

Valor Description
microsoft.base

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 niveles de zoom de 0 a 22. Formato: vector (pbf).

microsoft.base.labels

Muestra etiquetas para carreteras, características naturales y artificiales en un icono vectorial.

Admite niveles de zoom de 0 a 22. Formato: vector (pbf).

microsoft.base.hybrid

Muestra los datos de carretera, límite y etiqueta en un icono vectorial.

Admite niveles de zoom de 0 a 22. Formato: vector (pbf).

microsoft.terra.main

Relieve sombreado y capas de terra.

Admite niveles de zoom de 0 a 6. Formato: ráster (png).

microsoft.base.road

Todas las capas con nuestro estilo principal.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.base.darkgrey

Todas las capas con nuestro estilo gris oscuro.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.base.labels.road

Etiquete los datos en nuestro estilo principal.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.base.labels.darkgrey

Etiquete los datos en nuestro estilo gris oscuro.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.base.hybrid.road

Datos de carretera, límites y etiquetas en nuestro estilo principal.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.base.hybrid.darkgrey

Datos de carretera, límites y etiquetas en nuestro estilo gris oscuro.

Admite niveles de zoom de 0 a 22. Formato: ráster (png).

microsoft.imagery

Combinación de imágenes aéreas o satélites. Solo está disponible en la SKU de precios S1 y G2.

Admite niveles de zoom de 1 a 19. Formato: ráster (png).

microsoft.weather.radar.main

Mosaicos de radar meteorológicos. Imágenes de radar meteorológicas más recientes, incluidas áreas de lluvia, nieve, hielo y condiciones mixtas. Para más información sobre la cobertura del servicio meteorológico Azure Maps, consulte Azure Maps cobertura de servicios meteorológicos. Para más información sobre datos de radar, véase Servicios meteorológicos en Azure Maps.

Admite niveles de zoom de 0 a 15. Formato: ráster (png).

microsoft.weather.infrared.main

Azulejos infrarrojos meteorológicos. Las últimas imágenes de infrarrojos satélite muestran nubes por su temperatura. Para más información, consulte Azure Maps cobertura de servicios meteorológicos. Para más información sobre los datos satelitales devueltos, véase Servicios meteorológicos en Azure Maps.

Admite niveles de zoom de 0 a 15. Formato: ráster (png).

microsoft.traffic.absolute

iconos de tráfico absolutos en vector

microsoft.traffic.absolute.main

iconos de tráfico absolutos en ráster en nuestro estilo principal.

microsoft.traffic.relative

iconos de tráfico relativos en vector

microsoft.traffic.relative.main

iconos de tráfico relativos en ráster en nuestro estilo principal.

microsoft.traffic.relative.dark

iconos de tráfico relativos en ráster en nuestro estilo oscuro.

microsoft.traffic.delay

iconos de tráfico en vector

microsoft.traffic.delay.main

iconos de tráfico en ráster en nuestro estilo principal

microsoft.traffic.reduced.main

iconos de tráfico reducidos en ráster en nuestro estilo principal

microsoft.traffic.incident

iconos de incidentes en vector