Render - Get Map Tile

Serviço:

Maps

Versão da API:

1.0

use para obter blocos de mapa no formato vetor ou raster normalmente para serem integrados a um novo controle de mapa ou SDK.

Observação

Desativação do serviço Render v1 do Azure Mapas

Atualmente, o serviço Render v1 do Azure Mapas está preterido e será desativado em 17/09/26. Para evitar interrupções de serviço, todas as chamadas à API do Render v1 precisarão ser atualizadas para usar a API Render v2 em 17/09/26.

Busca blocos de mapa no formato vetor ou raster normalmente a serem integrados a um novo controle de mapa ou SDK. Por padrão, o Azure usa blocos de mapa de vetor para seu controle de mapa da Web (consulte Níveis de zoom e grade de blocos)

Observação: os blocos meteorológicos só estão disponíveis por meio da API Get Map Tile V2. Recomendamos começar a usar a nova API Get Map Tile 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 de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	TileFormat	Formato desejado da resposta. Os valores possíveis são png & pbf.
api-version	query	True	string	Número de versão da API de Mapas Azure.
layer	query	True	MapTileLayer	Camada de mapa solicitada. Os valores possíveis são básicos, híbridos, rótulos e terra.
style	query	True	MapTileStyle	Estilo de mapa a ser retornado. Os valores possíveis são main, escuro e shaded_relief.
x	query	True	integer int32	Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1]. Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.
y	query	True	integer int32	Coordenada Y do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1]. Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.
zoom	query	True	integer int32	Nível de zoom para o bloco desejado. Consulte Níveis de Zoom e Grade de Blocos para obter detalhes.
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes.
tileSize	query		MapTileSize	O tamanho do bloco de mapa retornado em pixels.
view	query		LocalizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	object	Esta imagem é retornada de uma chamada de bloco Obter Mapa bem-sucedida Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Cabeçalhos Content-Type: string
Other Status Codes	ErrorResponse	Erro inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

• Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

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

Escopos

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

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Tile Request

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

Content-Type: image/png

"{file}"

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LocalizedMapView	O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.
MapTileLayer	Camada de mapa solicitada. Os valores possíveis são básicos, híbridos, rótulos e terra.
MapTileSize	O tamanho do bloco de mapa retornado em pixels.
MapTileStyle	Estilo de mapa a ser retornado. Os valores possíveis são main, escuros e shaded_relief.
TileFormat	Formato desejado da resposta. Os valores possíveis são png & pbf.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

LocalizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.

Nome	Tipo	Description
AE	string	Emirados Árabes Unidos (Exibição Árabe)
AR	string	Argentina (Exibição Argentina)
Auto	string	Retornar os dados do mapa com base no endereço IP da solicitação.
BH	string	Bahrein (Exibição Árabe)
IN	string	Índia (Exibição Indiana)
IQ	string	Iraque (Exibição Árabe)
JO	string	Jordânia (Exibição Árabe)
KW	string	Kuwait (Exibição Árabe)
LB	string	Líbano (Exibição Árabe)
MA	string	Marrocos (Exibição Marroquina)
OM	string	Omã (Exibição Árabe)
PK	string	Paquistão (Exibição Paquistanesa)
PS	string	Autoridade Palestina (Exibição Árabe)
QA	string	Qatar (Exibição Árabe)
SA	string	Arábia Saudita (Exibição Árabe)
SY	string	Síria (Exibição Árabe)
Unified	string	Exibição Unificada (Outras)
YE	string	Iêmen (Exibição Árabe)

MapTileLayer

Camada de mapa solicitada. Os valores possíveis são básicos, híbridos, rótulos e terra.

Nome	Tipo	Description
basic	string	Retorna um bloco que contém todos os recursos do mapa, incluindo polígonos, bordas, estradas e rótulos.
hybrid	string	Retorna um bloco que contém bordas, estradas e rótulos e pode ser sobreposto em outros blocos (como imagens de satélite) para produzir blocos híbridos.
labels	string	Retorna um bloco de apenas as informações de rótulo do mapa.
terra	string	Tela de mapa completa com blocos de relevo sombreados. Há suporte para níveis de zoom de 0 a 6 (inclusivos). Png é o único TileFormat com suporte e apenas MapTileSize disponível é 512.

MapTileSize

O tamanho do bloco de mapa retornado em pixels.

Nome	Tipo	Description
256	string	Retornar um bloco de 256 por 256 pixels.
512	string	Retornar um bloco de 512 por 512 pixels.

MapTileStyle

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

Nome	Tipo	Description
dark	string	Versão cinza escuro do estilo Azure Mapas main. PNG é o único TileFormat com suporte.
main	string	estilo Azure Mapas main
shaded_relief	string	Azure Mapas main estilo concluído com alívio sombreado. Com suporte da Camada terra.

TileFormat

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

Nome	Tipo	Description
pbf	string	Gráfico vetor no formato pbf. Dá suporte aos níveis de zoom de 0 a 22.
png	string	Uma imagem no formato png. Dá suporte aos níveis de zoom de 0 a 18.