Share via


Render - Get Map Imagery Tile

Devolve um mosaico de imagem de mapa com o tamanho 256x256, dadas as coordenadas x e y e o nível de zoom, que varia entre 1 e 19.

Nota

descontinuação do serviço Azure Maps Render v1

O serviço Azure Maps Render v1 foi preterido e será descontinuado a 17/09/26. Para evitar interrupções de serviço, todas as chamadas à API Render v1 terão de ser atualizadas para utilizar a API Render v2 até 17/09/26.

O valor de estilo disponível atual é "satélite", que fornece apenas imagens de satélite.

Nota: recomendamos que comece a utilizar a nova API Obter Mosaico de Mapa V2.

GET https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom={zoom}&x={x}&y={y}

Parâmetros do URI

Name Em Necessário Tipo Description
format
path True

RasterTileFormat

Formato pretendido da resposta. Valor possível: png.

api-version
query True

string

Número da versão da API Azure Maps.

style
query True

MapImageryStyle

Estilo de mapa a devolver. Valores possíveis: satélite.

x
query True

integer

int32

Coordenada X do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1].

Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.

y
query True

integer

int32

Coordenada Y do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1].

Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.

zoom
query True

integer

int32

Nível de zoom para o mosaico pretendido.

Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-id

string

Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

object

Esta imagem é devolvida a partir de uma chamada get Map Imagery Tile com êxito

Media Types: "application/json", "image/jpeg", "image/png"

Headers

Content-Type: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Media Types: "application/json", "image/jpeg", "image/png"

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

  • Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

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

Esta é uma chave partilhada que é aprovisionada quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successful Imagery Tile Request

Sample Request

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

Sample Response

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

Definições

Name Description
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

MapImageryStyle

Estilo de mapa a devolver. Valores possíveis: satélite.

RasterTileFormat

Formato pretendido da resposta. Valor possível: png.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

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 a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

MapImageryStyle

Estilo de mapa a devolver. Valores possíveis: satélite.

Name Tipo Description
satellite

string

Imagens de satélite

RasterTileFormat

Formato pretendido da resposta. Valor possível: png.

Name Tipo Description
png

string

Uma imagem no formato png. Suporta níveis de zoom de 0 a 18.