Render - Get Map Tile

Aplica-se a: consulte os tipos de preços.

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. É recomendável começar a usar a nova API get map V2.

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

Name In Required Type Description
format
path True

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

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

style
query True

Estilo de mapa a ser retornado. Os valores possíveis são principais, escuros 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 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 os idiomas com suporte para obter detalhes.

tileSize
query

O tamanho do bloco de mapa retornado em pixels.

view
query

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 geopoliticamente disputadas. Diferentes países têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país que seu aplicativo estará atendendo. 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 Exibir 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 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 os modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

Cabeçalho da solicitação

Name Required Type Description
x-ms-client-id
  • string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Azure AD. 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 Azure AD segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Name Type Description
200 OK
  • object

Essa imagem é retornada de uma chamada bem-sucedida do bloco Get Map

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

Headers

  • Content-Type: string
Other Status Codes

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 OAuth2 do Azure Active Directory . 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 modelagem de aplicativos por meio de objetos capazes de controlar o acesso 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 do Mapas.

É 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 do Azure Active Directory. * 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.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

Essa é uma chave compartilhada que é 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 mestra 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.

Type: apiKey
In: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação DE SAS de Lista 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 para 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 forma mais protegida do que a chave compartilhada.

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

Type: apiKey
In: header

Exemplos

Successful Tile Request

Sample Request

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

Sample Response

Content-Type: image/png
"{file}"

Definições

ErrorAdditionalInfo

As informações adicionais sobre o 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 geopoliticamente disputadas. Diferentes países 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 que seu aplicativo estará servindo. 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 Exibir 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 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 os modos de exibição com suporte para obter detalhes e ver os Modos de Exibição 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 principais, escuros e shaded_relief.

TileFormat

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

ErrorAdditionalInfo

As informações adicionais sobre o erro de gerenciamento de recursos.

Name Type Description
info
  • object

As informações adicionais.

type
  • string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name Type Description
additionalInfo

As informações adicionais do erro.

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 Type 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 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 que seu aplicativo estará servindo. 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 Exibir 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 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 os modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis.

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

Name Type Description
basic
  • string

Retorna um bloco que contém todos os recursos de 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 (inclusive). Png é o único TileFormat com suporte e somente MapTileSize disponível é 512.

MapTileSize

O tamanho do bloco de mapa retornado em pixels.

Name Type 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 principais, escuros e shaded_relief.

Name Type Description
dark
  • string

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

main
  • string

Azure Mapas estilo principal

shaded_relief
  • string

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

TileFormat

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

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