Map Configuration - Create

Ссылка

Служба:: Maps Creator

Версия API:: 2023-03-01-preview

Используется для создания конфигурации карты.

Заметка

Azure Maps Creator

Служба azure Maps Creator в помещении теперь устарела и будет прекращена 9.30.25. Дополнительные сведения см. в объявлении о завершении жизни создателя Azure Maps.

Дополнительные сведения о конфигурации карты см. в статье Creator for indoor maps.

Отправка запроса на создание

API конфигурации карты Create — это запрос HTTP POST, используемый для создания конфигурации карты.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает расположение ресурса Создателя Azure Maps. Допустимые значения являются нами и eu.
api-version	query	True	string	Номер версии API Azure Maps.
alias	query		string	Псевдоним конфигурации карты. Максимальная длина 1024 символов. Псевдоним не может начинаться с `microsoft-maps` который является зарезервированным префиксом. Псевдоним можно указать при необходимости во время создания конфигурации карты, и его можно использовать так же, как mapConfigurationId после создания конфигурации карты.
description	query		string	Пользователь предоставил описание конфигурации карты. Максимальная длина 1024 символов.

Заголовок запроса

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

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Текст запроса

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

Имя	Обязательно	Тип	Описание
version	True	number (float)	В настоящее время поддерживается только версия конфигурации карты версии 1.0.
configurations		ConfigurationObject[]	Массив Configurations позволяет клиенту настраивать различные представления карт для набора плиток. Каждая конфигурация, настроенная здесь, будет отражена как один стиль карты в средстве выбора стилей в клиентском пакете SDK. Имя должно быть уникальным в массиве конфигураций.
defaultConfiguration		string	Конфигурация карты по умолчанию. Значение должно быть одним из полей name в ConfigurationObject в массиве configurations. Если это не указано, будет использоваться первая запись в списке конфигураций.
description		string	Описание вызывающего объекта при создании конфигурации карты. Максимальная длина 1024 символов.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос принят: запрос был принят для обработки. Для получения состояния используйте URL-адрес в заголовке Operation-Location. Заголовки Operation-Location: string
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Имя

Тип

Описание

202 Accepted

Запрос принят: запрос был принят для обработки. Для получения состояния используйте URL-адрес в заголовке Operation-Location.

Заголовки

Operation-Location: string

Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Create a map configuration by providing a configuration file

Образец запроса

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"
        }
      ]
    }
  ]
}

Пример ответа

Код состояния:: 202

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

Определения

Имя	Описание
BaseMap	Базовая карта — это фоновый слой для частной карты помещений. Это свойство необязательно, базовая карта не будет отображаться, если она не указана. Максимальная длина 100 символов.
ConfigurationObject	Определите формат для настройки средства выбора стилей и связанной карты в клиентском пакете SDK.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
MapConfiguration	Объект конфигурации карты, описывающий формат json конфигурации карты.
theme	Тема мини-приложений пакета SDK для клиента (средство выбора стилей, масштабирование, средство выбора уровней).
TilesetStyleTuple	Кортеж TilesetId и StyleId

BaseMap

Перечисление

Базовая карта — это фоновый слой для частной карты помещений. Это свойство необязательно, базовая карта не будет отображаться, если она не указана. Максимальная длина 100 символов.

Значение	Описание
microsoft_dark	Базовый стиль темной дорожной карты.
microsoft_grayscale_dark	Стиль темной карты серого уровня.
microsoft_grayscale_light	Стиль карты с оттенками серого цвета.
microsoft_high_contrast_dark	Стиль темной карты с высокой контрастностью.
microsoft_high_contrast_light	Стиль карты с высокой контрастностью.
microsoft_light	Стиль базовой дорожной карты.
microsoft_satellite	Стиль карты спутниковых изображений.
microsoft_satellite_road	Стиль вспомогательной и дорожной карты.
microsoft_shaded_relief	Стиль затененой карты рельефа.

ConfigurationObject

Object

Определите формат для настройки средства выбора стилей и связанной карты в клиентском пакете SDK.

Имя	Тип	Описание
baseMap	BaseMap	Базовая карта — это фоновый слой для частной карты помещений. Это свойство необязательно, базовая карта не будет отображаться, если она не указана. Максимальная длина 100 символов.
description	string	Описание стиля. Максимальная длина 500 символов.
displayName	string	Отображаемое имя средства выбора стилей в клиентском пакете SDK. Максимальная длина 255 символов.
layers	TilesetStyleTuple[]	Настройка стиля набора плиток. Вы можете использовать один стиль для всего набора плиток. Кроме того, можно использовать разные стили для разных слоев в одном наборе плиток, например один стиль для слоя `indoor unit` и другого стиля для `indoor facility` слоя. Кроме того, у вас есть один стиль для разного набора плиток
name	string	Имя стиля. Максимальная длина 255 символов.
theme	theme	Тема мини-приложений пакета SDK для клиента (средство выбора стилей, масштабирование, средство выбора уровней).
thumbnail	string	Файл эскиза изображения для средства выбора стилей в клиентском пакете SDK. Максимальная длина 255 символов. Ограничение размера составляет 400 КБ, а ограничение пикселей — 512*512.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.