Render - Get Map Tile
use para obtener iconos de mapa en formato vectorial o ráster normalmente para integrarse en un nuevo control de mapa o SDK.
Nota:
Retirada del servicio Render v1 de Azure Maps
El servicio Render v1 de Azure Maps ya está en desuso y se retirará el 17/9/26. Para evitar interrupciones del servicio, todas las llamadas a render v1 API deberán actualizarse para usar la versión más reciente de render API 9/17/26.
Captura los iconos de mapa en formato vectorial o ráster normalmente para integrarse en un nuevo control de mapa o SDK. De forma predeterminada, Azure usa mosaicos de mapas vectoriales para su control de mapa web (consulte Niveles de zoom y cuadrícula de mosaicos)
Nota: Los mosaicos meteorológicos no están disponibles mediante la API Get Map Tile v1.0. Recomendamos usar la versión más reciente de la API Get Map Tile.
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato deseado de la respuesta. Los valores posibles son png & pbf. |
|
|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
|
layer
|
query | True |
Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra. |
|
|
style
|
query | True |
Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief. |
|
|
x
|
query | True |
integer (int32) |
Coordenada X del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2 Consulte niveles de zoom y de cuadrícula de mosaico para obtener más información. |
|
y
|
query | True |
integer (int32) |
Coordenada Y del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2 Consulte niveles de zoom y de cuadrícula de mosaico para obtener más información. |
|
zoom
|
query | True |
integer (int32) |
Nivel de zoom del icono deseado. Consulte niveles de zoom y de cuadrícula de mosaico para obtener más información. |
|
language
|
query |
string |
Idioma en el que se deben devolver los resultados de la búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte idiomas admitidos para obtener más información. |
|
|
tile
|
query |
Tamaño del icono de mapa devuelto en píxeles. |
||
|
view
|
query |
El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica la cuenta destinada a su uso con el modelo de seguridad de identificador de Microsoft Entra. Este identificador único para la cuenta de Azure Maps se puede obtener de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
object |
Esta imagen se devuelve de una llamada correcta a Get Map Tile Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Encabezados Content-Type: string |
| Other Status Codes |
Error inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
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-idpara 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
Successful Tile Request
Solicitud de ejemplo
GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22
Respuesta de muestra
Content-Type: image/png
"{file}"
Definiciones
| Nombre | Description |
|---|---|
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Localized |
El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles. |
|
Map |
Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra. |
|
Map |
Tamaño del icono de mapa devuelto en píxeles. |
|
Map |
Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief. |
|
Tile |
Formato deseado de la respuesta. Los valores posibles son png & pbf. |
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 |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
Mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
LocalizedMapView
El parámetro View (también denominado parámetro "user region") permite mostrar los mapas correctos para un determinado país o región para regiones geopolíticamente disputadas. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región a la que va a servir la aplicación. De forma predeterminada, el parámetro View se establece en "Unified" incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de los usuarios y, a continuación, establecer el parámetro View correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa en función de la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que los mapas, imágenes y otros datos y contenido de terceros a los que está autorizado para acceder a través de Azure Maps está disponible. Ejemplo: view=IN.
Consulte vistas admitidas para obtener más información y ver las vistas disponibles.
| Valor | Description |
|---|---|
| AE |
Emiratos Árabes Unidos (vista árabe) |
| AR |
Argentina (Vista argentina) |
| BH |
Bahréin (vista árabe) |
| IN |
India (Vista india) |
| IQ |
Irak (vista árabe) |
| JO |
Jordania (vista árabe) |
| KW |
Kuwait (vista árabe) |
| LB |
Líbano (vista árabe) |
| MA |
Marruecos (Vista marroquí) |
| OM |
Oman (vista árabe) |
| PK |
Pakistán (Vista paquistaní) |
| PS |
Autoridad Palestina (vista árabe) |
| QA |
Qatar (vista árabe) |
| SA |
Arabia Saudita (vista árabe) |
| SY |
Siria (vista árabe) |
| US |
Estados Unidos de América |
| YE |
Yemen (vista árabe) |
| Auto |
Devuelve los datos del mapa en función de la dirección IP de la solicitud. |
| Unified |
Vista unificada (otros) |
MapTileLayer
Capa de mapa solicitada. Los valores posibles son básico, híbrido, etiquetas y terra.
| Valor | Description |
|---|---|
| basic |
Devuelve un icono que contiene todas las características del mapa, incluidos los polígonos, los bordes, las carreteras y las etiquetas. |
| hybrid |
Devuelve un icono que contiene bordes, carreteras y etiquetas, y se puede superponer en otros iconos (como imágenes satélite) para generar iconos híbridos. |
| labels |
Devuelve un icono de solo la información de etiqueta del mapa. |
| terra |
Lienzo de mapa completo con mosaicos de relieve sombreado. Se admiten los niveles de zoom 0-6 (ambos incluidos). Png es el único TileFormat compatible y solo mapTileSize disponible es 512. |
MapTileSize
Tamaño del icono de mapa devuelto en píxeles.
| Valor | Description |
|---|---|
| 256 |
Devuelve un icono de 256 a 256 píxeles. |
| 512 |
Devuelve un icono de 512 por 512 píxeles. |
MapTileStyle
Estilo de mapa que se va a devolver. Los valores posibles son main, dark y shaded_relief.
| Valor | Description |
|---|---|
| main |
Estilo principal de Azure Maps |
| dark |
Versión gris oscura del estilo principal de Azure Maps. PNG es el único tileformat compatible. |
| shaded_relief |
Estilo principal de Azure Maps completado con relieve sombreado. Compatible con Layer terra. |
TileFormat
Formato deseado de la respuesta. Los valores posibles son png & pbf.
| Valor | Description |
|---|---|
| png |
Imagen en formato png. Admite niveles de zoom de 0 a 18. |
| pbf |
Gráfico vectorial en formato pbf. Admite niveles de zoom de 0 a 22. |