Map Configuration - Create

Referência

Serviço:: Maps Creator

Versão da API:: 2023-03-01-preview

Use para criar uma configuração de mapa.

Observação

Aposentadoria do Azure Maps Creator

O serviço de mapa interno do Azure Maps Creator foi preterido e será desativado em 30/09/25. Para obter mais informações, consulte Anúncio de fim da vida útil do Azure Maps Creator.

Para obter mais informações sobre o que é uma configuração de mapa, consulte o artigo Creator for indoor maps concepts.

Enviar Criar Pedido

A API de Create de Configuração de Mapa é uma solicitação de POST HTTP usada para criar uma nova configuração de mapa.

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

Com parâmetros opcionais:

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

Parâmetros do URI

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

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Microsoft Entra ID. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
version	True	number (float)	A versão da configuração do mapa, atualmente apenas a versão 1.0 é suportada.
configurations		ConfigurationObject[]	A matriz 'Configurações' permitirá que o cliente configure diferentes representações de mapa para seu conjunto de blocos. Cada configuração configurada aqui será refletida como um estilo de mapa no seletor de estilos no SDK do cliente. O nome deve ser exclusivo na matriz de configurações.
defaultConfiguration		string	A configuração padrão para a configuração do mapa. O valor deve ser um dos campos 'name' em ConfigurationObject na matriz 'configurations'. Se não for fornecida, será utilizada a primeira entrada na lista de «configurações».
description		string	A descrição que o chamador forneceu ao criar a configuração do mapa. Comprimento máximo 1024 caracteres.

Respostas

Name	Tipo	Description
202 Accepted		Pedido aceite: O pedido foi aceite para processamento. Utilize o URL no cabeçalho Operation-Location para obter o estado. Cabeçalhos 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 Operation-Location para obter o estado.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os Fluxos de do Azure Ative Directory OAuth2. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.

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 Ative Directory. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Ative Directory v1.0 ou v2.0 oferece suporte a Trabalho, Escola e Convidados, mas não oferece suporte a contas Pessoais.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

subscription-key

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de de aplicativos cliente confidenciais para acessar APIs REST do Azure Maps para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(õ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 forma mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta do Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Create a map configuration by providing a configuration file

Pedido de amostra

HTTP

POST https://us.atlas.microsoft.com/styles/mapconfigurations?api-version=2023-03-01-preview&alias=sample-alias&description=This is my first map configuration.

{
  "version": 1,
  "description": "This is Microsoft default indoor map configuration",
  "defaultConfiguration": "microsoft_light",
  "configurations": [
    {
      "name": "indoor_light",
      "displayName": "Indoor light",
      "description": "A base style for Azure Maps.",
      "theme": "light",
      "baseMap": "microsoft_light",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_2022-01-01"
        }
      ]
    },
    {
      "name": "indoor_dark",
      "displayName": "Indoor dark",
      "description": "A base style for Azure Maps.",
      "theme": "dark",
      "baseMap": "microsoft_dark",
      "layers": [
        {
          "tilesetId": "{tilesetId}",
          "styleId": "microsoft-maps:indoor_dark_2022-01-01"
        }
      ]
    }
  ]
}

Resposta da amostra

Código de estado:: 202

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

Definições

Name	Description
BaseMap	O mapa base é uma camada de fundo para um mapa interior privado. Esta propriedade é opcional, nenhum mapa base será mostrado se não for fornecido. Comprimento máximo 100 caracteres.
ConfigurationObject	Defina o formato para configurar um seletor de estilos e o mapa associado no SDK do cliente.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
MapConfiguration	Um objeto de configuração de mapa que descreve o formato json de configuração de mapa.
theme	O tema para widgets SDK cliente (seletor de estilo, zoom, seletor de nível).
TilesetStyleTuple	Tupla TilesetId e StyleId

BaseMap

Enumeração

O mapa base é uma camada de fundo para um mapa interior privado. Esta propriedade é opcional, nenhum mapa base será mostrado se não for fornecido. Comprimento máximo 100 caracteres.

Valor	Description
microsoft_dark	O estilo de mapa de estrada escuro da base.
microsoft_grayscale_dark	O estilo de mapa escuro em tons de cinza.
microsoft_grayscale_light	O estilo de mapa claro em escala de cinza.
microsoft_high_contrast_dark	O estilo de mapa escuro de alto contraste.
microsoft_high_contrast_light	O estilo de mapa de luz de alto contraste.
microsoft_light	O estilo do mapa de estrada base.
microsoft_satellite	O estilo do mapa de imagens de satélite.
microsoft_satellite_road	O estilo satélite e mapa de estrada.
microsoft_shaded_relief	O estilo de mapa de relevo sombreado.

ConfigurationObject

Object

Defina o formato para configurar um seletor de estilos e o mapa associado no SDK do cliente.

Name	Tipo	Description
baseMap	BaseMap	O mapa base é uma camada de fundo para um mapa interior privado. Esta propriedade é opcional, nenhum mapa base será mostrado se não for fornecido. Comprimento máximo 100 caracteres.
description	string	A descrição do estilo. Comprimento máximo 500 caracteres.
displayName	string	O nome para exibição do seletor de estilos no SDK do cliente. Comprimento máximo 255 caracteres.
layers	TilesetStyleTuple[]	Para configurar o estilo para tileset. Você pode ter um estilo para todo o conjunto de azulejos. E você pode ter estilos diferentes para diferentes camadas em um conjunto de blocos, por exemplo, um estilo para `indoor unit` camada e outro estilo para `indoor facility` camada. E você também tem um estilo para diferentes tileset
name	string	O nome do estilo. Comprimento máximo 255 caracteres.
theme	theme	O tema para widgets SDK cliente (seletor de estilo, zoom, seletor de nível).
thumbnail	string	O arquivo de imagem em miniatura para o seletor de estilos no SDK do cliente. Comprimento máximo 255 caracteres. O limite de tamanho é de 400KB e o limite de pixels é de 512 * 512.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.