Render - Get Map State Tile

Service:

Maps

API Version:

2022-08-01

Utilize para obter mosaicos de estado no formato de vetor que podem ser utilizados para apresentar informações de estado de funcionalidades num mapa interior.

A Get Map State Tile API é um pedido HTTP GET que obtém mosaicos de estado no formato de vetor, normalmente para serem integrados no módulo de mapas interiores de um controlo de mapa ou SDK. O controlo de mapa chama esta API depois de o estilo dinâmico estar ativado. Para obter mais informações, veja Níveis de Zoom e Grelha de Mosaicos.

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom={zoom}&x={x}&y={y}&statesetId={statesetId}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	Número da versão da API Azure Maps. A versão atual é 2022-08-01
statesetId	query	True	string	O ID do stateset.
x	query	True	integer int32	Coordenada X do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
y	query	True	integer int32	Coordenada Y do mosaico na grelha de zoom. O valor tem de estar no intervalo [0, 2zoom -1]. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.
zoom	query	True	integer int32	Nível de zoom para o mosaico pretendido. Veja Níveis de Zoom e Grelha de Mosaicos para obter detalhes.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps veja os seguintes artigos para obter orientações.

Respostas

Name	Tipo	Description
200 OK	object	Este mosaico é devolvido a partir de uma chamada Get Map State Tile bem-sucedida Media Types: "application/vnd.mapbox-vector-tile", "application/json" Headers Content-Type: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado. Media Types: "application/vnd.mapbox-vector-tile", "application/json"

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

• Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

• Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação List SAS no recurso de Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

Successful State Tile Request

Sample Request

HTTP

GET https://atlas.microsoft.com/map/statetile?api-version=2022-08-01&zoom=6&x=10&y=22&statesetId=[statesetId]

Sample Response

Status code:

200

Content-Type: application/vnd.mapbox-vector-tile

Response Body

"{file}"

Definições

Name	Description
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	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 a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.