Render - Get Map Tile

Serviço:

Maps

Versão da API:

1.0

utilize para obter mosaicos de mapa em formato de vetor ou raster, normalmente para serem integrados num novo controlo de mapa ou SDK.

Nota

descontinuação do serviço Azure Maps Render v1

O serviço Azure Maps Render v1 foi preterido e será descontinuado a 17/09/26. Para evitar interrupções do serviço, todas as chamadas à API Render v1 terão de ser atualizadas para utilizar a API de Composição v2 até 17/09/26.

Obtém mosaicos de mapa no formato de vetor ou raster normalmente para serem integrados num novo controlo de mapa ou SDK. Por predefinição, o Azure utiliza mosaicos de mapa de vetor para o respetivo controlo de mapa Web (veja Níveis de Zoom e Grelha de Mosaicos)

Nota: os mosaicos meteorológicos só estão disponíveis através da API Obter Mosaico de Mapa V2. Recomendamos que comece a utilizar a nova API Obter Mosaico de Mapa V2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

Com parâmetros opcionais:

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 do URI

Name	Em	Necessário	Tipo	Description
format	path	True	TileFormat	Formato pretendido da resposta. Os valores possíveis são png & pbf.
api-version	query	True	string	Número da versão da API Azure Maps.
layer	query	True	MapTileLayer	Camada de mapa pedida. Os valores possíveis são básicos, híbridos, etiquetas e terra.
style	query	True	MapTileStyle	Estilo de mapa a devolver. Os valores possíveis são principais, escuros e shaded_relief.
x	query	True	integer int32	Coordenada X do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
y	query	True	integer int32	Coordenada Y do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
zoom	query	True	integer int32	Nível de zoom para o mosaico pretendido. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
language	query		string	Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de idioma IETF suportadas, não sensíveis a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido. Consulte idiomas suportados para obter detalhes.
tileSize	query		MapTileSize	O tamanho do mosaico de mapa devolvido em píxeis.
view	query		LocalizedMapView	O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	object	Esta imagem é devolvida a partir de uma chamada Obter Mosaico de Mapa com êxito Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Cabeçalhos Content-Type: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

• Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

• Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Tile Request

Pedido de amostra

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Resposta da amostra

Código de estado:

200

Content-Type: image/png

"{file}"

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
LocalizedMapView	O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN. Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.
MapTileLayer	Camada de mapa pedida. Os valores possíveis são básicos, híbridos, etiquetas e terra.
MapTileSize	O tamanho do mosaico do mapa devolvido em píxeis.
MapTileStyle	Estilo de mapa a ser devolvido. Os valores possíveis são principais, escuros e shaded_relief.
TileFormat	Formato pretendido da resposta. Os valores possíveis são png & pbf.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que irá devolver os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte As Vistas Suportadas para obter detalhes e ver as Vistas disponíveis.

Name	Tipo	Description
AE	string	Emirados Árabes Unidos (Vista Árabe)
AR	string	Argentina (Vista Argentina)
Auto	string	Devolver os dados do mapa com base no endereço IP do pedido.
BH	string	Barém (Vista Árabe)
IN	string	Índia (Vista Indiana)
IQ	string	Iraque (Vista Árabe)
JO	string	Jordânia (Vista Árabe)
KW	string	Kuwait (Vista Árabe)
LB	string	Líbano (Vista Árabe)
MA	string	Marrocos (Vista Marroquina)
OM	string	Omã (Vista Árabe)
PK	string	Paquistão (Vista Paquistanesa)
PS	string	Autoridade Palestiniana (Vista Árabe)
QA	string	Qatar (Vista Árabe)
SA	string	Arábia Saudita (Vista Árabe)
SY	string	Síria (Vista Árabe)
Unified	string	Vista Unificada (Outros)
YE	string	Iémen (Vista Árabe)

MapTileLayer

Camada de mapa pedida. Os valores possíveis são básicos, híbridos, etiquetas e terra.

Name	Tipo	Description
basic	string	Devolve um mosaico que contém todas as funcionalidades do mapa, incluindo polígonos, limites, estradas e etiquetas.
hybrid	string	Devolve um mosaico que contém limites, estradas e etiquetas e pode ser sobreposto noutros mosaicos (como imagens de satélite) para produzir mosaicos híbridos.
labels	string	Devolve um mosaico apenas das informações da etiqueta do mapa.
terra	string	Tela de mapa completa com mosaicos de relevo sombreado. Os níveis de zoom 0-6 (inclusive) são suportados. Png é o único TileFormat suportado e apenas mapTileSize disponível é 512.

MapTileSize

O tamanho do mosaico do mapa devolvido em píxeis.

Name	Tipo	Description
256	string	Devolver um mosaico de 256 por 256 píxeis.
512	string	Devolver um mosaico de 512 por 512 píxeis.

MapTileStyle

Estilo de mapa a ser devolvido. Os valores possíveis são principais, escuros e shaded_relief.

Name	Tipo	Description
dark	string	Versão cinzenta escura do estilo principal Azure Maps. PNG é o único TileFormat suportado.
main	string	Azure Maps estilo principal
shaded_relief	string	Azure Maps estilo principal completo com relevo sombreado. Suportado pelo Terra da Camada.

TileFormat

Formato pretendido da resposta. Os valores possíveis são png & pbf.

Name	Tipo	Description
pbf	string	Gráfico de vetor no formato pbf. Suporta níveis de zoom de 0 a 22.
png	string	Uma imagem no formato png. Suporta níveis de zoom de 0 a 18.