Tileset - List
Use para obter uma lista de blocos.
Enviar Solicitação de Lista
A List
API é uma solicitação HTTP GET
usada para buscar uma lista de todos os blocos existentes.
GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
geography
|
path | True |
string |
Esse parâmetro especifica onde o recurso criador de Azure Mapas está localizado. Os valores válidos são nós e eu. |
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
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 |
Liste a solicitação de conjunto de blocos concluída com êxito. O corpo da resposta contém uma lista de todos os blocos. |
|
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.
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 quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.
Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.
Tipo:
apiKey
Em:
query
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.
Tipo:
apiKey
Em:
header
Exemplos
Get a list of all tilesets
Solicitação de exemplo
GET https://us.atlas.microsoft.com/tilesets?api-version=2.0
Resposta de exemplo
{
"tilesets": [
{
"tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
"datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
"description": "My first tileset",
"minZoom": 16,
"maxZoom": 18,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
},
{
"tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
"datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
"description": "My second tileset",
"minZoom": 19,
"maxZoom": 19,
"bbox": [
-122.13595,
47.636524,
-122.1329,
47.637525
]
}
]
}
Definições
Nome | Description |
---|---|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Tileset |
Informações detalhadas dos dados. |
Tileset |
O modelo de resposta para a API de Lista de Conjuntos de Blocos. Retorna uma lista de todos os conjuntos de blocos. |
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. |
Tileset
Informações detalhadas dos dados.
Nome | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora na qual todos os recursos do conjunto de blocos estão dentro. Projeção usada – EPSG:3857. Formato: 'minLon, minLat, maxLon, maxLat'. |
datasetId |
string |
A ID de conjunto de dados exclusiva usada para criar o conjunto de blocos. |
description |
string |
A descrição fornecida pelo chamador ao criar o conjunto de blocos. Comprimento máximo de 1024 caracteres. |
maxZoom |
integer |
O bloco de nível de zoom de bloco mais alto gerado para o conjunto de blocos. |
minZoom |
integer |
O bloco de nível de zoom de bloco mais baixo gerado para o conjunto de blocos. |
ontology |
string |
A versão de ontologia desse conjunto de dados. |
tilesetId |
string |
A ID de conjunto de blocos exclusiva para o conjunto de blocos. |
TilesetListResult
O modelo de resposta para a API de Lista de Conjuntos de Blocos. Retorna uma lista de todos os conjuntos de blocos.
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
Se estiver presente, o local da próxima página de dados. |
tilesets |
Tileset[] |
Uma lista de todos os conjuntos de blocos. |