Render - Get Map Tile
Use para solicitar blocos de mapa no formato vetor ou de varredura.
**
A Get Map Tiles
API é uma solicitação HTTP GET
que permite que os usuários solicitem blocos de mapa em formatos de vetor ou de varredura, normalmente a serem integrados a um controle de mapa ou SDK. Alguns blocos de exemplo que podem ser solicitados são Azure Mapas blocos de estrada, blocos de Radar Meteorológico em tempo real ou os blocos de mapa criados usando Azure Mapas Criador. Por padrão, Azure Mapas usa blocos de vetor para seu controle de mapa da Web (SDK da Web) e SDK do Android.
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}
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 é 01-08-2022 |
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 peças tem um tilesetId a ser usado ao fazer solicitações. O tilesetId para conjuntos de blocos criados usando Azure Mapas Criador são gerados por meio da API de Criação de Conjunto de Blocos. Os conjuntos de blocos prontos para uso fornecidos pelo Azure Mapas estão listados abaixo. Por exemplo, microsoft.base. |
|
x
|
query | True |
integer int32 |
Coordenada X do bloco na grade de zoom. O valor deve estar no intervalo [0, 2 Consulte 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, 2 Consulte Níveis de Zoom e Grade de Blocos para obter detalhes. |
zoom
|
query | True |
integer int32 |
Nível de zoom para o bloco desejado. Consulte Níveis de Zoom e Grade de Blocos para obter detalhes. |
language
|
query |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado. Consulte Idiomas com suporte para obter detalhes. |
|
tile
|
query |
O tamanho do bloco de mapa retornado em pixels. |
||
time
|
query |
string date-time |
A data e a hora desejadas do bloco solicitado. Esse parâmetro deve ser especificado no formato de data e hora padrão (por exemplo, 2019-11-14T16:03:00-08:00), conforme definido pela ISO 8601. Esse parâmetro só tem suporte quando o parâmetro tilesetId é definido como um dos valores abaixo.
|
|
view
|
query |
O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização dos usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas é disponibilizado. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e ver os Modos de Exibição disponíveis. |
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 do 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 |
O bloco retornado de uma chamada à API bem-sucedida. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string |
Other Status Codes |
Erro inesperado. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
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 a Azure Mapas APIs REST. 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 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 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 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 de 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 para 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 com base na 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 para a expiração, a taxa e as 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 de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Type:
apiKey
In:
header
Exemplos
Successful Tile Request
Sample Request
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Sample Response
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definições
Nome | Description |
---|---|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Localized |
O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN. Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis. |
Map |
O tamanho do bloco de mapa retornado em pixels. |
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. |
LocalizedMapView
O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN.
Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.
Nome | Tipo | Description |
---|---|---|
AE |
string |
Emirados Árabes Unidos (Exibição Árabe) |
AR |
string |
Argentina (Exibição Argentina) |
Auto |
string |
Retornar os dados do mapa com base no endereço IP da solicitação. |
BH |
string |
Bahrein (Exibição Árabe) |
IN |
string |
Índia (Exibição Indiana) |
IQ |
string |
Iraque (Exibição Árabe) |
JO |
string |
Jordânia (Exibição Árabe) |
KW |
string |
Kuwait (Exibição Árabe) |
LB |
string |
Líbano (Exibição Árabe) |
MA |
string |
Marrocos (Exibição Marroquina) |
OM |
string |
Omã (Exibição Árabe) |
PK |
string |
Paquistão (Exibição Paquistanesa) |
PS |
string |
Autoridade Palestina (Exibição Árabe) |
QA |
string |
Qatar (Exibição Árabe) |
SA |
string |
Arábia Saudita (Exibição Árabe) |
SY |
string |
Síria (Exibição Árabe) |
Unified |
string |
Exibição Unificada (Outras) |
YE |
string |
Iêmen (Exibição Árabe) |
MapTileSize
O tamanho do bloco de mapa retornado em pixels.
Nome | Tipo | Description |
---|---|---|
256 |
string |
Retornar um bloco de 256 por 256 pixels. |
512 |
string |
Retornar um bloco de 512 por 512 pixels. |
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). |