Render - Get Map Tile
Use para solicitar blocos de mapa em formato vetorial ou raster.
A Get Map Tiles API permite que os usuários solicitem blocos de mapa em formatos vetoriais ou rasterizados, normalmente para integração em um controle de mapa ou SDK. Os tipos de mosaico suportados incluem mosaicos rodoviários do Azure Maps e mosaicos do Radar meteorológico em tempo real. Por padrão, o SDK da Web do Azure Maps usa blocos vetoriais 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}
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 do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. A versão atual é 2024-04-01. |
|
tileset
|
query | True |
Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps 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, 2 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, 2 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 em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. |
|
|
tile
|
query |
O tamanho do bloco de mapa retornado em pixels. |
||
|
time
|
query |
string (date-time) |
A data e hora desejadas do bloco solicitado. Este parâmetro deve ser especificado no formato padrão de data-hora (por exemplo, 2019-11-14T16:03:00-08:00), conforme definido pela ISO 8601. Este parâmetro só é suportado quando o parâmetro tilesetId é definido como um dos valores abaixo.
|
|
|
view
|
query |
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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
Cabeçalho do Pedido
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps. |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
object |
O bloco retornou 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 |
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 Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.
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 ID do Microsoft Entra.
* O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
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
Essa é uma chave compartilhada que é provisionada ao criar um de recursos do
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura 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 do
Tipo:
apiKey
Em:
header
Exemplos
Successful Tile Request
Pedido de amostra
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Resposta da amostra
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definições
| Name | Description |
|---|---|
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Localized |
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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN. Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis. |
|
Map |
O tamanho do bloco de mapa retornado em pixels. |
| TilesetID |
Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base. |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
| Name | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| additionalInfo |
O erro informações adicionais. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Name | Tipo | Description |
|---|---|---|
| error |
O objeto 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.
Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.
| Valor | Description |
|---|---|
| AE |
Emirados Árabes Unidos (Vista árabe) |
| AR |
Argentina (Vista Argentina) |
| BH |
Bahrein (Vista árabe) |
| IN |
Índia (Vista indiana) |
| IQ |
Iraque (Vista árabe) |
| JO |
Jordânia (Vista árabe) |
| KW |
Kuwait (Vista árabe) |
| LB |
Líbano (Vista árabe) |
| MA |
Marrocos (Vista Marroquina) |
| OM |
Omã (Vista árabe) |
| PK |
Paquistão (Vista paquistanesa) |
| PS |
Autoridade Palestiniana (Vista árabe) |
| QA |
Qatar (Vista árabe) |
| SA |
Arábia Saudita (Vista árabe) |
| SY |
Síria (Vista árabe) |
| US |
Estados Unidos da América |
| YE |
Iémen (Vista árabe) |
| Auto |
Retornar os dados do mapa com base no endereço IP da solicitação. |
| Unified |
Modo de Exibição Unificado (Outros) |
MapTileSize
O tamanho do bloco de mapa retornado em pixels.
| Valor | Description |
|---|---|
| 256 |
Retornar um bloco de 256 por 256 pixels. |
| 512 |
Retornar um bloco de 512 por 512 pixels. |
TilesetID
Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os conjuntos de mosaicos prontos a utilizar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.
| Valor | Description |
|---|---|
| microsoft.base |
Um mapa base é um mapa padrão que exibe estradas, características naturais e artificiais, juntamente com os rótulos para essas características em um bloco vetorial. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf). |
| microsoft.base.labels |
Exibe etiquetas para estradas, características naturais e artificiais em uma telha vetorial. Suporta 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 vetorial. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf). |
| microsoft.terra.main |
Relevo sombreado e camadas de terra. Suporta níveis de zoom de 0 a 6. Formato: raster (png). |
| microsoft.base.road |
Todas as camadas com o nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.darkgrey |
Todas as camadas com o nosso estilo cinza escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.labels.road |
Rotule os dados no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.labels.darkgrey |
Rotule os dados no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.hybrid.road |
Dados de estradas, limites e etiquetas no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.hybrid.darkgrey |
Dados de estradas, limites e rótulos no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.imagery |
Uma combinação de imagens de satélite ou aéreas. Disponível apenas em SKU de preços S1 e G2. Suporta níveis de zoom de 1 a 19. Formato: raster (png). |
| microsoft.weather.radar.main |
Telhas 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 Meteorologia do Azure Maps, consulte Cobertura dos serviços meteorológicos do Azure Maps. Para obter mais informações sobre dados de radar, consulte Serviços meteorológicos no Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png). |
| microsoft.weather.infrared.main |
Telhas infravermelhas meteorológicas. As últimas imagens de satélite infravermelho mostram nuvens pela sua temperatura. Para obter mais informações, consulte Cobertura dos serviços meteorológicos do Azure Maps. Para obter mais informações sobre os dados de satélite retornados, consulte Serviços meteorológicos no Azure Maps. Suporta níveis de zoom de 0 a 15. Formato: raster (png). |
| microsoft.traffic.absolute |
blocos de tráfego absoluto no vetor |
| microsoft.traffic.absolute.main |
mosaicos de tráfego absolutos em raster no nosso estilo principal. |
| microsoft.traffic.relative |
blocos de tráfego relativo no vetor |
| microsoft.traffic.relative.main |
mosaicos de tráfego relativo em raster no nosso estilo principal. |
| microsoft.traffic.relative.dark |
Mosaicos de tráfego relativo em raster no nosso estilo escuro. |
| microsoft.traffic.delay |
blocos de tráfego no vetor |
| microsoft.traffic.delay.main |
Mosaicos de tráfego em raster no nosso estilo principal |
| microsoft.traffic.reduced.main |
Mosaicos de tráfego reduzidos em raster no nosso estilo principal |
| microsoft.traffic.incident |
blocos incidentes no vetor |