Render - Get Map Imagery Tile

Serviço:

Maps

Versão da API:

1.0

Retorna um bloco de imagem de mapa com tamanho 256x256, considerando as coordenadas x e y e o nível de zoom, que varia de 1 a 19.

Observação

Desativação do serviço Render v1 do Azure Mapas

Atualmente, o serviço Render v1 do Azure Mapas está preterido e será desativado em 17/09/26. Para evitar interrupções de serviço, todas as chamadas à API do Render v1 precisarão ser atualizadas para usar a API Render v2 em 17/09/26.

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

Observação: recomendamos começar a usar a nova API Get Map Tile V2.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
format	path	True	RasterTileFormat	Formato desejado da resposta. Valor possível: png.
api-version	query	True	string	Número de versão da API de Mapas Azure.
style	query	True	MapImageryStyle	Estilo de mapa a ser retornado. Valores possíveis: satélite.
x	query	True	integer int32	Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2zoom -1]. Confira 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]. Confira Níveis de Zoom e Grade de Blocos para obter detalhes.
zoom	query	True	integer int32	Nível de zoom para o bloco desejado. Confira Níveis de Zoom e Grade de Blocos para obter detalhes.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-id		string	Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. 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 Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	object	Esta imagem é retornada de uma chamada de bloco Obter Imagem de Mapa bem-sucedida Media Types: "application/json", "image/jpeg", "image/png" Cabeçalhos Content-Type: string
Other Status Codes	ErrorResponse	Erro inesperado. Media Types: "application/json", "image/jpeg", "image/png"

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. 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 modelar aplicativos por meio de objetos capazes de acessar o controle 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 de Mapas.

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 Microsoft Entra ID. * 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.

• Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.

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

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS 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 à 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 maneira mais segura do que a chave compartilhada.

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

Tipo: apiKey
Em: header

Exemplos

Successful Imagery Tile Request

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

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
MapImageryStyle	Estilo de mapa a ser retornado. Valores possíveis: satélite.
RasterTileFormat	Formato desejado da resposta. Valor possível: png.

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.

MapImageryStyle

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

Nome	Tipo	Description
satellite	string	Imagens de satélite

RasterTileFormat

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

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