Render - Get Map Tile
Use para solicitar iconos de mapa en formato vectorial o ráster.
La Get Map Tiles API permite a los usuarios solicitar teselas de mapa en formatos vectoriales o ráster, normalmente para su integración en un control de mapa o SDK. Los tipos de casillas soportadas incluyen Azure Maps, losetas de carretera y fichas de Weather Radar en tiempo real. Por defecto, el Azure Maps Web SDK utiliza mosaicos vectoriales para renderizar su control de mapa web.
Importante
Al usar la API Get Map Tile , también debes llamar a la API Get Map Attribution para recuperar el texto de atribución de datos de mapa requerido.
La atribución devuelta debe mostrarse dondequiera que se muestren las teselas recuperadas de Get Map Tile , incluyendo controles de mapas de terceros o implementaciones de renderizado personalizadas.
GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
El nombre de host del servicio Azure Maps. Usa |
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
|
tileset
|
query | True |
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. |
|
|
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. |
||
|
time
|
query |
string (date-time) |
Fecha y hora deseadas del icono solicitado. Este parámetro debe especificarse en el formato de fecha y hora estándar (por ejemplo, 2019-11-14T16:03:00-08:00), tal como se define en ISO 8601. Este parámetro solo se admite cuando el parámetro tilesetId se establece en uno de los valores siguientes.
|
|
|
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 de Vista en Azure Maps debe utilizarse en cumplimiento de las leyes aplicables, incluidas las relativas al mapeo, del país/región donde se ponen a disposición los mapas, imágenes y otros datos y contenidos de terceros autorizados a acceder a través de Azure Maps. 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 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 |
string |
La solicitud se ha realizado correctamente. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
| Other Status Codes |
Una respuesta de error inesperada. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
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. 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.
Note
- 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 URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - 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 |
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:
header
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?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Respuesta de muestra
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definiciones
| Nombre | Description |
|---|---|
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
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). |
|
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 de Vista en Azure Maps debe utilizarse en cumplimiento de las leyes aplicables, incluidas las relativas al mapeo, del país/región donde se ponen a disposición los mapas, imágenes y otros datos y contenidos de terceros autorizados a acceder a través de Azure Maps. Ejemplo: view=IN. Consulte vistas admitidas para obtener más información y ver las vistas disponibles. |
|
Map |
Tamaño del icono de mapa devuelto en píxeles. |
| 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 |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
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 |
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 de Vista en Azure Maps debe utilizarse en cumplimiento de las leyes aplicables, incluidas las relativas al mapeo, del país/región donde se ponen a disposición los mapas, imágenes y otros datos y contenidos de terceros autorizados a acceder a través de Azure Maps. 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 |
Baré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 |
Omán (vista árabe) |
| PK |
Pakistán (vista pakistaní) |
| PS |
Autoridad Nacional Palestina (vista árabe) |
| QA |
Catar (vista árabe) |
| SA |
Arabia Saudí (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) |
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. |
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 |