Tileset - Get

Referência

Service:: Maps Creator

API Version:: 2023-03-01-preview

Use para obter os detalhes de um conjunto de peças.

Enviar Solicitação de Obtenção

A Get API é uma solicitação HTTP GET usada para buscar os detalhes de um conjunto de blocos.

GET https://{geography}.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
geography	path	True	string	Esse parâmetro especifica onde o recurso Azure Mapas Creator está localizado. Os valores válidos são nós e eu.
tilesetId	path	True	string	A ID do conjunto de peças
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 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	Tileset	Solicitação de conjunto de blocos de lista concluída com êxito. O corpo da resposta contém uma lista de todos os conjuntos de peças.
Other Status Codes	ErrorResponse	Erro inesperado.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . 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 do Azure Active Directory. * 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.

Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

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 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.

Type: apiKey
In: query

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

Gets the details for a single tileset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/tilesets/{tilesetId}?api-version=2023-03-01-preview

Sample Response

Status code:: 200

{
  "tilesetId": "{tilesetId}",
  "datasetId": "{datasetId}",
  "description": "My first tileset",
  "minZoom": 16,
  "maxZoom": 18,
  "bbox": [
    -122.13595,
    47.636524,
    -122.1329,
    47.637525
  ]
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
Feature	Configuração de recursos para a configuração do conjunto de blocos.
LayerObject	Objeto layer para a configuração do conjunto de blocos.
Tileset	Informações detalhadas dos dados.
TilesetConfiguration	Campos de nível superior de configuração de conjunto de blocos. Uma configuração de conjunto de peças é um objeto JSON que deve conter os seguintes campos de nível superior:

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

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Feature

Configuração de recursos para a configuração do conjunto de blocos.

Nome	Tipo	Description
featureClasses	string[]	A lista de classes de recursos que serão usadas para criar a camada. As classes de recurso válidas podem ser encontradas em sua definição de ontologia. Por exemplo, Ontologia de Instalação
filter	object	Remove recursos que não correspondem a um padrão. Consulte a expressão de filtro MapLibre

LayerObject

Objeto layer para a configuração do conjunto de blocos.

Nome	Tipo	Description
features	Feature	Especifica as classes de recurso e os filtros.
maxZoom	integer	O nível de zoom mais alto para a camada a ser compilada.
minZoom	integer	O nível de zoom mais baixo para a camada a ser compilada.

Tileset

Informações detalhadas dos dados.

Nome	Tipo	Description
bbox	number[]	Caixa delimitadora na qual todos os recursos do conjunto de peças estão contidos. 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.
defaultMapConfigurationId	string	A ID de configuração de mapa gerada padrão para 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.
tilesetConfiguration	TilesetConfiguration	Configuração do conjunto de peças que é usada para criar o conjunto de blocos.
tilesetId	string	A ID de conjunto de peças exclusiva para o conjunto de peças.

TilesetConfiguration

Campos de nível superior de configuração de conjunto de blocos. Uma configuração de conjunto de peças é um objeto JSON que deve conter os seguintes campos de nível superior:

Nome	Tipo	Description
layers	<string, LayerObject>	Os nomes das camadas e suas opções de configuração. O objeto de camadas de configuração contém pares chave-valor que associam os nomes das camadas de bloco à sua configuração. Para cada par chave-valor, a chave é o nome da camada e o valor é um LayerObject que contém a configuração e as opções da camada. Cada camada deve ter um nome. Esse é o identificador exclusivo para a camada de dados em seu conjunto de blocos final. Em qualquer conjunto de blocos, cada nome de camada deve ser exclusivo. O nome da camada deve ser uma cadeia de caracteres com apenas sublinhados (_) e caracteres alfanuméricos. O LayerObject correspondente para cada nome de camada descreve como essa camada de bloco de vetor deve ser criada. Ele especifica quais classes de recursos recuperar dados de recursos, a precisão dos dados por meio de níveis de zoom e como transformar recursos e renderizá-los em blocos.
version	integer	A versão do Azure Mapas referência de configuração do serviço tiling usada pela configuração do conjunto de blocos. Atualmente, somente a versão 1 é permitida. O uso de qualquer outra versão da versão atual ou de uma versão anterior resultará em um erro.

Share via