Render - Get Map Tileset

Use para obter metadados para um conjunto de blocos.
A API Get Map Tileset permite que os usuários solicitem metadados para um conjunto de blocos.

GET {endpoint}/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string (uri)

O nome de host do serviço Azure Maps. Usa https://atlas.microsoft.com para a Azure cloud pública. Para direcionar uma geografia Azure Maps específica ou uma nuvem soberana, veja Azure Maps âmbito geográfico.

api-version
query True

string

minLength: 1

A versão da API a utilizar para esta operação.

tilesetId
query True

TilesetID

Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

Cabeçalho do Pedido

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

string

Indica a conta destinada a ser utilizada com o modelo de segurança do Microsoft Entra ID. Este ID único para a conta Azure Maps pode ser obtido a partir da API da conta Azure Maps plano de gestão. Para mais informações sobre o uso da segurança Microsoft Entra ID em Azure Maps, consulte Gerir autenticação em Azure Maps.

Respostas

Name Tipo Description
200 OK

MapTileset

O pedido foi bem-sucedido.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

AadToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando combinado com controlo Azure baseado em funções, pode ser usado para controlar o acesso a APIs REST Azure Maps. Os controlos de acesso baseados em papéis do Azure são usados para designar o acesso a uma ou mais contas ou subrecursos de recursos do Azure Maps. 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 Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Note

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.
  • O Authorization URL é específico para a instância de nuvem pública do Azure. As clouds soberanas têm URLs de Autorização e configurações de Microsoft Entra ID únicas.
  • O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
  • Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: header

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 segura 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 do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successful Tileset Request

Pedido de amostra

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

Resposta da amostra

{
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "bounds": [
    -180,
    -90,
    180,
    90
  ],
  "maxzoom": 22,
  "minzoom": 0,
  "scheme": "xyz",
  "tilejson": "2.2.0",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "version": "1.0.0"
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

MapTileset

Metadados para um conjunto de blocos no formato TileJSON.

TilesetID

Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

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 comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Name Tipo Description
error

ErrorDetail

O objeto de erro.

MapTileset

Metadados para um conjunto de blocos no formato TileJSON.

Name Tipo Description
attribution

string

Atribuição de direitos autorais a ser exibida no mapa. As implementações PODEM decidir tratar isso 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 rastreamento de XSS ou beacon.

bounds

number[] (float)

A extensão máxima dos blocos de mapa disponíveis. Os limites DEVEM definir uma área coberta por todos os níveis de zoom. Os limites são representados em WGS:84 valores de latitude e longitude, na ordem esquerda, inferior, direita, superior. Os valores podem ser inteiros ou números de ponto flutuante.

center

number[] (float)

O local padrão do conjunto de blocos no formato [longitude, latitude, zoom]. O nível de zoom DEVE estar entre minzoom e maxzoom. As implementações podem usar esse valor para definir o local padrão.

data

string[]

Uma matriz de arquivos de dados no formato GeoJSON.

description

string

Descrição em texto do conjunto de mosaicos. A descrição pode conter qualquer natureza jurídica. As implementações NÃO DEVEM interpretar a descrição como HTML.

grids

string[]

Uma matriz de pontos de extremidade de interatividade.

legend

string

Uma legenda a ser exibida com o mapa. As implementações PODEM decidir tratar isso 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 rastreamento de XSS ou beacon.

maxzoom

integer (int32)

minimum: 0
maximum: 30

O nível máximo de zoom.

minzoom

integer (int32)

minimum: 0
maximum: 30

O nível mínimo de zoom.

name

string

Um nome que descreve o conjunto de blocos. O nome pode conter qualquer personalidade jurídica. As implementações NÃO DEVEM interpretar o nome como HTML.

scheme

string

Padrão: "xyz". "xyz" ou "tms". Influencia a direção y das coordenadas do bloco. O perfil global-mercator (também conhecido como Spherical Mercator) é assumido.

template

string

Um modelo de bigode a ser usado para formatar dados de grades para interação.

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Descreve a versão da especificação TileJSON que é implementada por este objeto JSON.

tiles

string[]

Uma matriz de pontos de extremidade de bloco. Se vários pontos de extremidade forem especificados, os clientes poderão usar qualquer combinação de pontos de extremidade. Todos os pontos de extremidade DEVEM retornar o mesmo conteúdo para a mesma URL. A matriz DEVE conter pelo menos um ponto de extremidade.

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

Um número de versão de estilo semver.org para os blocos contidos no conjunto de blocos. Quando as alterações nos blocos são introduzidas, a versão secundária DEVE ser alterada.

TilesetID

Um conjunto de blocos é uma coleção de dados raster ou vetoriais divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada tileset tem um tilesetId para usar ao fazer solicitações. Os tilesets prontos a usar fornecidos pelo Azure Maps estão listados abaixo. Por exemplo, microsoft.base.

Valor Description
microsoft.base

Um mapa base é um mapa padrão que exibe estradas, características naturais e artificiais, juntamente com os rótulos para essas características em um bloco vetorial.

Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).

microsoft.base.labels

Exibe etiquetas para estradas, características naturais e artificiais em uma telha vetorial.

Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).

microsoft.base.hybrid

Exibe dados de estrada, limite e rótulo em um bloco vetorial.

Suporta níveis de zoom de 0 a 22. Formato: vetor (pbf).

microsoft.terra.main

Relevo sombreado e camadas de terra.

Suporta níveis de zoom de 0 a 6. Formato: raster (png).

microsoft.base.road

Todas as camadas com o nosso estilo principal.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.base.darkgrey

Todas as camadas com o nosso estilo cinza escuro.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.base.labels.road

Rotule os dados no nosso estilo principal.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.base.labels.darkgrey

Rotule os dados no nosso estilo cinzento escuro.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.base.hybrid.road

Dados de estradas, limites e etiquetas no nosso estilo principal.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.base.hybrid.darkgrey

Dados de estradas, limites e rótulos no nosso estilo cinzento escuro.

Suporta níveis de zoom de 0 a 22. Formato: raster (png).

microsoft.imagery

Uma combinação de imagens de satélite ou aéreas. Disponível apenas em SKU de preços S1 e G2.

Suporta níveis de zoom de 1 a 19. Formato: raster (png).

microsoft.weather.radar.main

Telhas de radar meteorológico. Últimas imagens de radar meteorológico, incluindo áreas de chuva, neve, gelo e condições mistas. Para mais informações sobre a cobertura do serviço meteorológico Azure Maps, consulte Azure Maps cobertura dos serviços meteorológicos. Para mais informações sobre dados de radar, consulte Serviços meteorológicos em Azure Maps.

Suporta níveis de zoom de 0 a 15. Formato: raster (png).

microsoft.weather.infrared.main

Telhas infravermelhas meteorológicas. As últimas imagens de satélite infravermelho mostram nuvens pela sua temperatura. Para mais informações, consulte Azure Maps cobertura de serviços meteorológicos. Para mais informações sobre os dados de satélite devolvidos, consulte Serviços meteorológicos em Azure Maps.

Suporta níveis de zoom de 0 a 15. Formato: raster (png).

microsoft.traffic.absolute

blocos de tráfego absoluto no vetor

microsoft.traffic.absolute.main

mosaicos de tráfego absolutos em raster no nosso estilo principal.

microsoft.traffic.relative

blocos de tráfego relativo no vetor

microsoft.traffic.relative.main

mosaicos de tráfego relativo em raster no nosso estilo principal.

microsoft.traffic.relative.dark

Mosaicos de tráfego relativo em raster no nosso estilo escuro.

microsoft.traffic.delay

blocos de tráfego no vetor

microsoft.traffic.delay.main

Mosaicos de tráfego em raster no nosso estilo principal

microsoft.traffic.reduced.main

Mosaicos de tráfego reduzidos em raster no nosso estilo principal

microsoft.traffic.incident

blocos incidentes no vetor