Render - Get Map State Tile

Use para obtener iconos de estado en formato vectorial que se pueden usar para mostrar información de estado de características en un mapa interior.
Captura los iconos de estado en formato vectorial normalmente para integrarse en el módulo de mapas interiores del control de mapa o el SDK. El control de mapa llamará a esta API después de que el usuario active el estilo dinámico. Para obtener más información, vea niveles de zoom y cuadrícula de mosaico.

GET {endpoint}/map/statetile?api-version=2024-04-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string (uri)

El nombre de host del servicio Azure Maps. Usa https://atlas.microsoft.com para la nube pública Azure. Para dirigirse a una geografía Azure Maps específica o a una nube soberana, véase Azure Maps alcance geográfico.

api-version
query True

string

minLength: 1

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

statesetId
query True

string

Identificador del conjunto de estados.

x
query True

integer (int32)

Coordenada X del icono en la cuadrícula de zoom. El valor debe estar en el intervalo [0, 2zoom -1].

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, 2zoom -1].

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.

Encabezado de 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", "application/vnd.mapbox-vector-tile"

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Media Types: "application/json", "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-id 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.
  • El Authorization URL es 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 State Tile Request

Solicitud de ejemplo

GET https://atlas.microsoft.com/map/statetile?api-version=2024-04-01&zoom=6&x=10&y=22&statesetId=[statesetId]

Respuesta de muestra

Content-Type: application/vnd.mapbox-vector-tile
"{file}"

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

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.