Compartilhar via

Render - Get Map Tile

Serviço:
Maps
Versão da API:
2024-04-01

Use para solicitar blocos de mapa no formato vetor ou raster.

A Get Map Tiles API permite que os usuários solicitem blocos de mapa em formatos vetoriais ou raster, normalmente para integração em um controle de mapa ou SDK. Os tipos de bloco com suporte incluem blocos de estrada do Azure Mapas e blocos de radar meteorológico em tempo real. Por padrão, o SDK da Web do Azure Mapas usa blocos de vetor para renderizar seu controle de mapa da Web.

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
Com parâmetros opcionais: 
GET https://atlas.microsoft.com/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 URI

Nome Em Obrigatório Tipo Description
api-version
 query True

string

Número de versão da API do Azure Mapas. Versão atual é 2024-04-01.
tilesetId
 query True

TilesetID

Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base.
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 de 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 de 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 de 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 linguagem 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 de idiomas com suporte para obter detalhes.
tileSize
 query

MapTileSize

O tamanho do bloco de mapa retornado em pixels.
timeStamp
 query

string (date-time)

A data e a hora desejadas do bloco solicitado. Esse parâmetro deve ser especificado no formato de data e hora padrão (por exemplo, 2019-11-14T16:03:00-08:00), conforme definido por ISO 8601. Esse parâmetro só tem suporte quando o parâmetro tilesetId é definido como um dos valores abaixo.

  • microsoft.weather.infrared.main: fornecemos blocos de até 3 horas no passado. Os blocos estão disponíveis em intervalos de 10 minutos. Arredondamos o valor de timeStamp para o período de tempo mais próximo de 10 minutos.
  • microsoft.weather.radar.main: Fornecemos blocos de até 1,5 horas no passado e até 2 horas no futuro. Os blocos estão disponíveis em intervalos de 5 minutos. Arredondamos o valor de timeStamp para o período de tempo mais próximo de 5 minutos.
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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas.

Respostas

Nome Tipo Description
200 OK

object

O bloco retornado de uma chamada de API 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

Ocorreu um erro inesperado.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 APIs REST do Azure Mapas.

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 controlar o acesso em APIs e escopos específicos.

Anotações

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

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

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 ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

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

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) 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 forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de 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

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Resposta de exemplo

Código de status:
200 
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"

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 que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.
MapTileSize

O tamanho do bloco de mapa retornado em pixels.
TilesetID

Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

LocalizedMapView

Enumeração

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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Valor Description
AE

Emirados Árabes Unidos (Exibição Árabe)
AR

Argentina (Exibição Argentina)
BH

Bahrein (Exibição Árabe)
IN

Índia (Exibição Indiana)
IQ

Iraque (Exibição Árabe)
JO

Jordânia (Exibição Árabe)
KW

Kuwait (Exibição Árabe)
LB

Líbano (Exibição Árabe)
MA

Marrocos (Exibição Marroquina)
OM

Omã (Exibição Árabe)
PK

Paquistão (Exibição Paquistanesa)
PS

Autoridade Palestina (Exibição Árabe)
QA

Qatar (Exibição Árabe)
SA

Arábia Saudita (Exibição Árabe)
SY

Síria (Exibição Árabe)
US

Estados Unidos da América
YE

Iêmen (Exibição Árabe)
Auto

Retorne os dados do mapa com base no endereço IP da solicitação.
Unified

Exibição Unificada (Outras)

MapTileSize

Enumeração

O tamanho do bloco de mapa retornado em pixels.

Valor Description
256

Retorne um bloco de 256 por 256 pixels.
512

Retorne um bloco de 512 por 512 pixels.

TilesetID

Enumeração

Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base.

Valor Description
microsoft.base

Um mapa base é um mapa padrão que exibe estradas, recursos naturais e artificiais, juntamente com os rótulos desses recursos em um bloco de vetor.

Dá suporte aos níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.labels

Exibe rótulos para estradas, recursos naturais e artificiais em um bloco de vetor.

Dá suporte aos níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.hybrid

Exibe dados de estrada, limite e rótulo em um bloco de vetor.

Dá suporte aos níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.terra.main

Relevo sombreado e camadas de terra.

Dá suporte aos níveis de zoom de 0 a 6. Formato: raster (png).
microsoft.base.road

Todas as camadas com nosso estilo principal.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.darkgrey

Todas as camadas com nosso estilo cinza escuro.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.road

Rotule dados em nosso estilo principal.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.darkgrey

Rotule dados em nosso estilo cinza escuro.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.road

Dados de estrada, limite e rótulo em nosso estilo principal.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.darkgrey

Dados de estrada, limite e rótulo em nosso estilo cinza escuro.

Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.imagery

Uma combinação de imagens aéreas ou satélites. Disponível apenas no SKU de preços S1 e G2.

Dá suporte aos níveis de zoom de 1 a 19. Formato: raster (png).
microsoft.weather.radar.main

Blocos de radar meteorológico. Últimas imagens de radar meteorológico, incluindo áreas de chuva, neve, gelo e condições mistas. Para obter mais informações sobre a cobertura do serviço meteorológico do Azure Mapas, consulte Cobertura dos serviços meteorológicos do Azure Mapas. Para obter mais informações sobre dados de radar, consulte Serviços meteorológicos no Azure Mapas.

Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.weather.infrared.main

Blocos infravermelhos meteorológicos. As últimas imagens de satélite infravermelho mostram nuvens pela temperatura. Para obter mais informações, consulte Cobertura dos serviços meteorológicos do Azure Mapas. Para obter mais informações sobre os dados de satélite retornados, consulte Serviços meteorológicos no Azure Mapas.

Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.traffic.absolute

blocos de tráfego absolutos no vetor
microsoft.traffic.absolute.main

blocos de tráfego absolutos em raster em nosso estilo principal.
microsoft.traffic.relative

blocos de tráfego relativos no vetor
microsoft.traffic.relative.main

blocos de tráfego relativos em raster em nosso estilo principal.
microsoft.traffic.relative.dark

blocos de tráfego relativos em raster em nosso estilo escuro.
microsoft.traffic.delay

blocos de tráfego no vetor
microsoft.traffic.delay.main

blocos de tráfego em raster em nosso estilo principal
microsoft.traffic.reduced.main

blocos de tráfego reduzidos em raster em nosso estilo principal
microsoft.traffic.incident

blocos de incidente no vetor