Render - Get Map Tileset
Use para obter metadados para um conjunto de blocos.
**
A Get Map Tileset
API é uma solicitação HTTP GET
permite que os usuários solicitem metadados para um conjunto de blocos.
GET https://atlas.microsoft.com/map/tileset?api-version=2022-08-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 de Mapas Azure. A versão atual é 2022-08-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. A tilesetId para conjuntos de blocos criados usando Azure Mapas Criador são geradas por meio da API de Criação de Conjunto de Blocos. Os conjuntos de blocos prontos para uso fornecidos por 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 |
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 |
OK |
|
Other Status Codes |
Erro inesperado. |
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.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um 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 essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como master chaves para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de Azure Mapas APIs REST em que essa chave pode ser armazenada com segurança.
Type:
apiKey
In:
header
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.
Type:
apiKey
In:
header
Exemplos
Successful Tileset Request
Sample Request
GET https://atlas.microsoft.com/map/tileset?api-version=2022-08-01&tilesetId=microsoft.base
Sample Response
{
"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
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. A tilesetId para conjuntos de blocos criados usando Azure Mapas Criador são geradas por meio da API de Criação de Conjunto de Blocos. Os conjuntos de blocos prontos para uso fornecidos por 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. Limites DEVEM definir uma área coberta por todos os níveis de zoom. Os limites são representados em valores de latitude e longitude WGS:84, na ordem esquerda, inferior, direita, superior. Os valores podem ser inteiros ou números de ponto flutuante. |
center |
number[] |
O local padrão do conjunto de blocos no formulário [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. 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 |
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 blocos. O nome pode conter qualquer caractere legal. 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 Mercator Esférico) é assumido. |
template |
string |
Um modelo de bigode a ser usado para formatar dados de grades para interação. |
tilejson |
string |
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 |
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. A tilesetId para conjuntos de blocos criados usando Azure Mapas Criador são geradas por meio da API de Criação de Conjunto de Blocos. Os conjuntos de blocos prontos para uso fornecidos por Azure Mapas estão listados abaixo. Por exemplo, microsoft.base.
Nome | Tipo | Description |
---|---|---|
microsoft.base |
string |
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.darkgrey |
string |
Todas as camadas com nosso estilo cinza escuro. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
microsoft.base.hybrid |
string |
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.base.hybrid.darkgrey |
string |
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.base.hybrid.road |
string |
Dados de estrada, limite e rótulo em nosso estilo de main. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
microsoft.base.labels |
string |
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.labels.darkgrey |
string |
Rotule os dados em nosso estilo cinza escuro. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
microsoft.base.labels.road |
string |
Rotular dados em nosso estilo de main. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
microsoft.base.road |
string |
Todas as camadas com nosso estilo main. Dá suporte aos níveis de zoom de 0 a 22. Formato: raster (png). |
microsoft.imagery |
string |
Uma combinação de imagens aéreas e satélites. Disponível apenas no SKU de preços do S1. Dá suporte aos níveis de zoom de 1 a 19. Formato: raster (jpeg). |
microsoft.terra.main |
string |
Relevo sombreado e camadas de terra. Dá suporte aos níveis de zoom de 0 a 6. Formato: raster (png). |
microsoft.traffic.absolute |
string |
blocos de tráfego absoluto no vetor |
microsoft.traffic.absolute.main |
string |
blocos de tráfego absolutos em raster em nosso estilo main. |
microsoft.traffic.delay |
string |
blocos de tráfego no vetor |
microsoft.traffic.delay.main |
string |
blocos de tráfego em raster em nosso estilo main |
microsoft.traffic.incident |
string |
blocos de incidentes no vetor |
microsoft.traffic.reduced.main |
string |
blocos de tráfego reduzidos em raster em nosso estilo main |
microsoft.traffic.relative |
string |
blocos de tráfego relativos no vetor |
microsoft.traffic.relative.dark |
string |
blocos de tráfego relativos em raster em nosso estilo escuro. |
microsoft.traffic.relative.main |
string |
blocos de tráfego relativos em raster em nosso estilo main. |
microsoft.weather.infrared.main |
string |
Blocos infravermelhos meteorológicos. As últimas imagens de satélite infravermelho mostram nuvens pela temperatura. Consulte as informações de cobertura para o serviço Azure Mapas Weather. Para saber mais sobre os dados de Satélite retornados, consulte Conceitos de clima. Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png). |
microsoft.weather.radar.main |
string |
Blocos de radar meteorológico. Últimas imagens de radar meteorológico, incluindo áreas de chuva, neve, gelo e condições mistas. Consulte as informações de cobertura para o serviço Azure Mapas Weather. Para saber mais sobre os dados do Radar, confira Conceitos de clima. Dá suporte aos níveis de zoom de 0 a 15. Formato: raster (png). |