Compartilhar via


Render - Get Map Tile

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 Renderização v1 do Azure Mapas

O serviço renderização v1 do Azure Mapas foi preterido e será desativado em 17/09/26. Para evitar interrupções de serviço, todas as chamadas à API renderizar v1 precisarão ser atualizadas para usar a versão mais recente da API de Renderização até 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 de clima não estão disponíveis usando a API Obter Bloco de Mapa v1.0. Recomendamos usar a versão mais recente da API Obter Bloco de Mapa .

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}
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 do Azure Mapas.

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 principal, 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 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.

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

Esta imagem é retornada de uma chamada de bloco Get Map 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 quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas 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 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/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Resposta de exemplo

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

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 principal, escuro 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 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 (Modo de Exibição Indiano)

IQ

Iraque (exibição árabe)

JO

Jordânia (exibição árabe)

KW

Kuwait (exibição árabe)

LB

Líbano (exibição árabe)

MA

Marrocos (Vista Marroquina)

OM

Omã (exibição árabe)

PK

Paquistão (Exibição paquistanesa)

PS

Autoridade Palestina (Exibição Árabe)

QA

Catar (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 (outros)

MapTileLayer

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

Valor Description
basic

Retorna um bloco que contém todos os recursos do mapa, incluindo polígonos, bordas, estradas e rótulos.

hybrid

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

Retorna um bloco de apenas as informações de rótulo do mapa.

terra

Tela de mapa completa com blocos de relevo sombreados. Há suporte para níveis de zoom de 0 a 6 (inclusive). Png é o único TileFormat com suporte e somente MapTileSize disponível é 512.

MapTileSize

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.

MapTileStyle

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

Valor Description
main

Estilo principal do Azure Mapas

dark

Versão cinza escuro do estilo principal do Azure Mapas. PNG é o único TileFormat com suporte.

shaded_relief

Estilo principal do Azure Mapas concluído com relevo sombreado. Compatível com o Layer Terra.

TileFormat

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

Valor Description
png

Uma imagem no formato png. Dá suporte aos níveis de zoom de 0 a 18.

pbf

Gráfico de vetor no formato pbf. Dá suporte aos níveis de zoom de 0 a 22.