Render - Get Map Tileset
Use para obter metadados de um conjunto de peças.
A API Get Map Tileset permite que os usuários solicitem metadados para um conjunto de blocos.
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. Versão atual é 2024-04-01. |
|
tileset
|
query | True |
Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada ao uso com o modelo de segurança de ID do Microsoft Entra. Essa ID exclusiva para a conta do Azure Mapas pode ser obtida na API da conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY |
|
| Other Status Codes |
Ocorreu um erro inesperado. |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. 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 Mapas.
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 controlar o acesso em APIs e escopos específicos.
Anotações
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.
O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra.
* O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
* O uso do SDK da Web do 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 a plataforma de identidade da Microsoft, consulte visão geral da 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 ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das 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ão(s) 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 de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Successful Tileset Request
Solicitação de exemplo
GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base
Resposta de exemplo
{
"tilejson": "2.2.0",
"version": "1.0.0",
"attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">©2022 TomTom</a>",
"scheme": "xyz",
"tiles": [
"https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
],
"minzoom": 0,
"maxzoom": 22,
"bounds": [
-180,
-90,
180,
90
]
}
Definições
| Nome | Description |
|---|---|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Map |
Metadados de um conjunto de blocos no formato TileJSON. |
| TilesetID |
Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base. |
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 |
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
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
MapTileset
Metadados de um conjunto de blocos no formato TileJSON.
| Nome | Tipo | Description |
|---|---|---|
| attribution |
string |
Atribuição de direitos autorais a ser exibida no mapa. As implementações podem decidir tratar isso como TEXTO HTML ou literal. Por motivos de segurança, verifique se esse campo não pode ser abusado como um vetor para XSS ou rastreamento de sinalizador. |
| bounds |
number[] |
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 nos valores de latitude e longitude WGS:84, na ordem esquerda, inferior, direita, superior. Os valores podem ser números inteiros ou de ponto flutuante. |
| center |
number[] |
O local padrão do conjunto de blocos na forma [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 do texto do conjunto de blocos. A descrição pode conter qualquer caractere legal. 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 TEXTO HTML ou literal. Por motivos de segurança, verifique se esse campo não pode ser abusado como um vetor para XSS ou rastreamento de sinalizador. |
| maxzoom |
integer minimum: 0maximum: 30 |
O nível máximo de zoom. |
| minzoom |
integer minimum: 0maximum: 30 |
O nível mínimo de zoom. |
| name |
string |
Um nome que descreve o conjunto de blocos. O nome pode conter qualquer caractere legal. 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 de mercator global (também conhecido como Mercator Esférico) é 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 implementada por esse 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 semver.org número de versão de estilo para os blocos contidos no conjunto de blocos. Quando as alterações entre blocos são introduzidas, a versão secundária DEVE ser alterada. |
TilesetID
Um conjunto de peças é uma coleção de dados de raster ou vetor divididos em uma grade uniforme de blocos quadrados em níveis de zoom predefinidos. Cada conjunto de blocos tem um tilesetId a ser usado ao fazer solicitações. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base.
| Valor | Description |
|---|---|
| microsoft.base |
Um mapa base é um mapa padrão que exibe estradas, recursos naturais e artificiais, juntamente com os rótulos desses recursos em um bloco de vetor. Dá suporte aos níveis de zoom de 0 a 22. Formato: vetor (pbf). |
| microsoft.base.labels |
Exibe rótulos para estradas, recursos naturais e artificiais em um bloco de vetor. Dá suporte aos 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 de vetor. Dá suporte aos níveis de zoom de 0 a 22. Formato: vetor (pbf). |
| microsoft.terra.main |
Relevo sombreado e camadas de terra. Dá suporte aos níveis de zoom de 0 a 6. Formato: raster (png). |
| microsoft.base.road |
Todas as camadas com nosso estilo principal. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.darkgrey |
Todas as camadas com nosso estilo cinza escuro. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.labels.road |
Rotule dados em nosso estilo principal. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.labels.darkgrey |
Rotule dados em nosso estilo cinza escuro. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.hybrid.road |
Dados de estrada, limite e rótulo em nosso estilo principal. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.base.hybrid.darkgrey |
Dados de estrada, limite e rótulo em nosso estilo cinza escuro. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
| microsoft.imagery |
Uma combinação de imagens aéreas ou satélites. Disponível apenas no SKU de preços S1 e G2. Dá suporte aos níveis de zoom de 1 a 19. Formato: raster (png). |
| microsoft.weather.radar.main |
Blocos de radar meteorológico. Últimas imagens de radar meteorológico, incluindo áreas de chuva, neve, gelo e condições mistas. Para obter mais informações sobre a cobertura do serviço meteorológico do Azure Mapas, consulte Cobertura dos serviços meteorológicos do Azure Mapas. Para obter mais informações sobre dados de radar, consulte Serviços meteorológicos no Azure Mapas. Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png). |
| microsoft.weather.infrared.main |
Blocos infravermelhos meteorológicos. As últimas imagens de satélite infravermelho mostram nuvens pela temperatura. Para obter mais informações, consulte Cobertura dos serviços meteorológicos do Azure Mapas. Para obter mais informações sobre os dados de satélite retornados, consulte Serviços meteorológicos no Azure Mapas. Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png). |
| microsoft.traffic.absolute |
blocos de tráfego absolutos no vetor |
| microsoft.traffic.absolute.main |
blocos de tráfego absolutos em raster em nosso estilo principal. |
| microsoft.traffic.relative |
blocos de tráfego relativos no vetor |
| microsoft.traffic.relative.main |
blocos de tráfego relativos em raster em nosso estilo principal. |
| microsoft.traffic.relative.dark |
blocos de tráfego relativos em raster em nosso estilo escuro. |
| microsoft.traffic.delay |
blocos de tráfego no vetor |
| microsoft.traffic.delay.main |
blocos de tráfego em raster em nosso estilo principal |
| microsoft.traffic.reduced.main |
blocos de tráfego reduzidos em raster em nosso estilo principal |
| microsoft.traffic.incident |
blocos de incidente no vetor |