Style - Create

Referência

Service:: Maps Creator

API Version:: 2023-03-01-preview

Utilize para criar um estilo de Azure Maps.

Submeter Pedido de Criação

A Style Create API é um pedido HTTP POST utilizado para criar um estilo de Azure Maps ao transmitir um ficheiro JSON ou ZIP que contém as informações de estilo.

A API Criar Estilo é uma operação de execução prolongada.

POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview

With optional parameters:

POST https://{geography}.atlas.microsoft.com/styles?api-version=2023-03-01-preview&description={description}&alias={alias}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
geography	path	True	string	Este parâmetro especifica onde está localizado o recurso Azure Maps Creator. Os valores válidos somos nós e eu.
api-version	query	True	string	Número da versão da API Azure Maps.
alias	query		string	O alias do estilo. Comprimento máximo de 1024 carateres. O alias não pode começar com `microsoft-maps` um prefixo reservado. O alias pode ser fornecido opcionalmente durante a criação de um estilo e pode ser utilizado da mesma forma que styleId após a criação do estilo.
description	query		string	O utilizador forneceu a descrição do estilo. Comprimento máximo de 1024 carateres.

Cabeçalho do Pedido

Media Types: "application/json", "application/zip"

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.

Corpo do Pedido

Media Types: "application/json", "application/zip"

Name	Tipo	Description
CreateContent	object	O conteúdo de estilo a carregar. Se for fornecido o formato de dados JSON, o corpo do pedido deverá seguir a especificação Camadas na especificação Estilo MapLibre. Se for fornecido o formato de dados ZIP, também deve fornecer a folha sprite e os ficheiros de índice associados que contêm ícones utilizados no ficheiro json de configuração de estilo.

Respostas

Name	Tipo	Description
202 Accepted		Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho do Operation-Location para obter o estado. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Name

Tipo

Description

202 Accepted

Pedido Aceite: o pedido foi aceite para processamento. Utilize o URL no Cabeçalho do Operation-Location para obter o estado.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

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

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

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 quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Type: apiKey
In: query

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

Create Style by providing an azure maps style json file

Sample Request

HTTP

POST https://us.atlas.microsoft.com/styles?api-version=2023-03-01-preview&alias=test-alias

{
  "layers": [
    {
      "id": "background",
      "type": "background",
      "source-layer": "bg-source",
      "minzoom": 18,
      "maxzoom": 20,
      "layout": {
        "visibility": "none",
        "symbol-placement": "point",
        "symbol-avoid-edges": true,
        "text-field": "{name}",
        "text-keep-upright": true,
        "text-font": [
          "SegoeUi-SemiBold"
        ],
        "text-letter-spacing": 0.1,
        "text-size": {
          "stops": [
            [
              18.5,
              6.5
            ],
            [
              19,
              8
            ],
            [
              19.5,
              9.5
            ],
            [
              20,
              11
            ]
          ]
        },
        "text-anchor": "center"
      },
      "paint": {
        "text-color": "rgb(0, 0, 0)",
        "text-halo-color": "rgb(255, 255, 255)",
        "text-halo-width": 1,
        "text-halo-blur": 0.5
      }
    }
  ]
}

Sample Response

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

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.

Style - Create

Submeter Pedido de Criação

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

subscription-key

SAS Token

Exemplos

Create Style by providing an azure maps style json file

Sample Request

Sample Response

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Recursos adicionais