Render - Get Map Tileset

Referência

Service:: Maps

API Version:: 2022-08-01

Utilize para obter metadados para um conjunto de mosaicos.
**

A Get Map Tileset API é um pedido HTTP GET que permite aos utilizadores pedir metadados para um conjunto de mosaicos.

GET https://atlas.microsoft.com/map/tileset?api-version=2022-08-01&tilesetId={tilesetId}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	Número da versão da API Azure Maps. A versão atual é 2022-08-01
tilesetId	query	True	TilesetID	Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Azure Maps Creator é gerado através da API tileset Create. Os conjuntos de mosaicos prontos a utilizar fornecidos por Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

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 consulte os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	MapTileset	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

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 recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

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.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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 ao criar um recurso 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 esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso 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 Tileset Request

Sample Request

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2022-08-01&tilesetId=microsoft.base

Sample Response

Status code:: 200

{
  "tilejson": "2.2.0",
  "name": "microsoft.core.vector",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-dynamic=\"true\" data-azure-maps-attribution-tileset=\"microsoft.core.vector\"></a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2.1&tilesetId=microsoft.core.vector&zoom={z}&x={x}&y={y}&language=ngt"
  ],
  "grids": [],
  "data": [],
  "minzoom": 1,
  "maxzoom": 21,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

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
MapTileset	Metadados de um conjunto de mosaicos no formato TileJSON.
TilesetID	Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Azure Maps Creator é gerado através da API tileset Create. Os conjuntos de mosaicos prontos a utilizar fornecidos por Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

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ções adicionais.

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.

MapTileset

Metadados de um conjunto de mosaicos no formato TileJSON.

Name	Tipo	Description
attribution	string	Atribuição de direitos de autor a apresentar no mapa. As implementações podem decidir tratar isto como HTML ou texto literal. Por razões de segurança, certifique-se de que este campo não pode ser abusado como um vetor para controlo de XSS ou beacon.
bounds	number[]	A extensão máxima dos mosaicos de mapa disponíveis. Os limites TÊM de definir uma área abrangida por todos os níveis de zoom. Os limites são representados nos valores de latitude e longitude WGS:84, pela ordem esquerda, inferior, direita, superior. Os valores podem ser números inteiros ou de vírgula flutuante.
center	number[]	A localização predefinida do conjunto de mosaicos no formulário [longitude, latitude, zoom]. O nível de zoom TEM de estar entre minzoom e maxzoom. As implementações podem utilizar este valor para definir a localização predefinida.
data	string[]	Uma matriz de ficheiros de dados no formato GeoJSON.
description	string	Descrição do texto do conjunto de mosaicos. A descrição pode conter qualquer caráter legal. As implementações NÃO devem interpretar a descrição como HTML.
grids	string[]	Uma matriz de pontos finais de interatividade.
legend	string	Uma legenda a apresentar com o mapa. As implementações podem decidir tratar isto como HTML ou texto literal. Por razões de segurança, certifique-se de que este campo não pode ser abusado como um vetor para controlo de XSS ou beacon.
maxzoom	integer	O nível máximo de zoom.
minzoom	integer	O nível mínimo de zoom.
name	string	Um nome que descreve o conjunto de mosaicos. O nome pode conter qualquer caráter legal. As implementações NÃO devem interpretar o nome como HTML.
scheme	string	Predefinição: "xyz". "xyz" ou "tms". Influencia a direção y das coordenadas do mosaico. O perfil global-mercator (também conhecido como Mercator Esférico) é assumido.
template	string	Um modelo de bigode a ser utilizado para formatar dados de grelhas para interação.
tilejson	string	Descreve a versão da especificação TileJSON que é implementada por este objeto JSON.
tiles	string[]	Uma matriz de pontos finais de mosaico. Se forem especificados vários pontos finais, os clientes poderão utilizar qualquer combinação de pontos finais. Todos os pontos finais TÊM de devolver o mesmo conteúdo para o mesmo URL. A matriz TEM de conter, pelo menos, um ponto final.
version	string	Um semver.org número de versão de estilo para os mosaicos contidos no conjunto de mosaicos. Quando são introduzidas alterações em mosaicos, a versão secundária TEM de ser alterada.

TilesetID

Um conjunto de mosaicos é uma coleção de dados de raster ou vetor divididos numa grelha uniforme de mosaicos quadrados em níveis de zoom predefinidos. Cada conjunto de mosaicos tem um tilesetId para utilizar ao fazer pedidos. O tilesetId para conjuntos de mosaicos criados com o Azure Maps Creator é gerado através da API tileset Create. Os conjuntos de mosaicos prontos a utilizar fornecidos por Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

Name	Tipo	Description
microsoft.base	string	Um mapa base é um mapa padrão que apresenta estradas, características naturais e artificiais, juntamente com as etiquetas dessas funcionalidades num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.darkgrey	string	Todas as camadas com o nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid	string	Apresenta dados de estradas, limites e etiquetas num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.hybrid.darkgrey	string	Dados de estradas, limites e etiquetas no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.hybrid.road	string	Dados de estradas, limites e etiquetas no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels	string	Apresenta etiquetas para estradas, características naturais e artificiais num mosaico de vetor. Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).
microsoft.base.labels.darkgrey	string	Etiquetar dados no nosso estilo cinzento escuro. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.labels.road	string	Etiquetar dados no nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.base.road	string	Todas as camadas com o nosso estilo principal. Suporta níveis de zoom de 0 a 22. Formato: raster (png).
microsoft.imagery	string	Uma combinação de imagens aéreas e satélite. Apenas disponível no SKU de preços S1. Suporta níveis de zoom de 1 a 19. Formato: raster (jpeg).
microsoft.terra.main	string	Relevo sombreado e camadas de terra. Suporta níveis de zoom de 0 a 6. Formato: raster (png).
microsoft.traffic.absolute	string	mosaicos de tráfego absoluto no vetor
microsoft.traffic.absolute.main	string	mosaicos de tráfego absoluto no raster no nosso estilo principal.
microsoft.traffic.delay	string	mosaicos de tráfego no vetor
microsoft.traffic.delay.main	string	mosaicos de tráfego no raster no nosso estilo principal
microsoft.traffic.incident	string	mosaicos de incidentes no vetor
microsoft.traffic.reduced.main	string	mosaicos de tráfego reduzido no raster no nosso estilo principal
microsoft.traffic.relative	string	mosaicos de tráfego relativo no vetor
microsoft.traffic.relative.dark	string	mosaicos de tráfego relativo no raster no nosso estilo escuro.
microsoft.traffic.relative.main	string	mosaicos de tráfego relativo no raster no nosso estilo principal.
microsoft.weather.infrared.main	string	Mosaicos de infravermelhos meteorológicos. As últimas imagens de Satélite de Infravermelhos mostram nuvens pela sua temperatura. Veja as informações de cobertura do serviço Azure Maps Meteorologia. Para saber mais sobre os dados de Satélite devolvidos, veja Conceitos de meteorologia. Suporta níveis de zoom de 0 a 15. Formato: raster (png).
microsoft.weather.radar.main	string	Mosaicos de radar meteorológico. As últimas imagens de radares meteorológicos, incluindo áreas de chuva, neve, gelo e condições mistas. Veja as informações de cobertura do serviço Azure Maps Meteorologia. Para saber mais sobre os dados do Radar, consulte Conceitos de meteorologia. Suporta níveis de zoom de 0 a 15. Formato: raster (png).