Tileset - Create

Ссылка

Service:: Maps Creator

API Version:: 2023-03-01-preview

Используйте для создания набора плиток.

Create API — это HTTP-запросPOST, используемый для создания набора плиток из указанного набора данных. Дополнительные сведения см. в статье Создание набора плиток. Набор плиток содержит набор плиток, которые можно использовать с помощью команды Получить плитку карты для получения пользовательских плиток. Чтобы создать набор данных, используйте команду Создать набор данных. Общие сведения о концепциях и средствах, применимых к Azure Maps Creator, см. в статье Creator for indoor maps..

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

Чтобы создать набор плиток, выполните POST запрос с пустым текстом. Параметр datasetId запроса будет использоваться в качестве источника данных набора плиток.

API создания набора плиток — это длительная операция.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
geography	path	True	string	Этот параметр указывает, где находится ресурс Azure Maps Creator. Допустимые значения: us и eu.
api-version	query	True	string	Номер версии API Azure Maps
datasetId	query	True	string	Уникальность `datasetId` , которую API создания набора плиток использует для получения признаков для создания плиток. Объект `datasetId` должен быть получен из успешного вызова API создания набора данных .
description	query		string	Пользователь предоставил описание набора плиток. Максимальная длина 1024 символа.

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

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

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

Имя	Обязательно	Тип	Описание
layers	True	<string, LayerObject>	Имена слоев и их параметры конфигурации. Объект уровней конфигурации содержит пары "ключ-значение", связывающие имена слоев плиток с их конфигурацией. Для каждой пары "ключ-значение" ключ — это имя слоя, а значение — это объект LayerObject, содержащий конфигурацию и параметры слоя. Каждый слой должен иметь имя. Это уникальный идентификатор слоя данных в окончательном наборе плиток. В любом наборе плиток имя каждого слоя должно быть уникальным. Имя слоя должно быть строкой с символами подчеркивания (_) и буквенно-цифровыми символами. Соответствующий layerObject для каждого имени слоя описывает, как должен быть создан слой векторной плитки. Он указывает, какие классы признаков следует извлекать данные признаков, точность данных с помощью уровней масштабирования и как преобразовывать признаки и преобразовывать их в плитки.
version	True	integer	Версия ссылки на конфигурацию службы Azure Maps Tiling, которая используется в конфигурации набора плиток. В настоящее время разрешена только версия 1. Использование любой версии, отличной от текущей или предыдущей, приведет к ошибке.

Ответы

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

Имя

Тип

Описание

202 Accepted

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

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

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

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

AADToken

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

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным 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 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

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

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

Create Tileset by providing a Dataset Id

Sample Request

HTTP

POST https://us.atlas.microsoft.com/tilesets?api-version=2023-03-01-preview&datasetId=[dataset-Id]&description=Example description.

{
  "version": 1,
  "layers": {
    "Indoor unit": {
      "minZoom": 15,
      "maxZoom": 20,
      "features": {
        "featureClasses": [
          "unit"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "conference"
          ]
        ]
      }
    }
  }
}

Sample Response

Status code:: 202

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
Feature	Конфигурация компонентов для конфигурации набора плиток.
LayerObject	Объект слоя для конфигурации набора плиток.
TilesetConfiguration	Поля верхнего уровня конфигурации набора плиток. Конфигурация набора плиток — это объект JSON, который должен содержать следующие поля верхнего уровня:

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

Сообщение об ошибке

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

Feature

Конфигурация компонентов для конфигурации набора плиток.

Имя	Тип	Описание
featureClasses	string[]	Список классов признаков, которые будут использоваться для построения слоя. Допустимые классы признаков можно найти в определении онтологии. Например, Онтология объектов
filter	object	Удаляет компоненты, которые не соответствуют шаблону. См. выражение фильтра MapLibre

LayerObject

Объект слоя для конфигурации набора плиток.

Имя	Тип	Описание
features	Feature	Указывает классы функций и фильтры.
maxZoom	integer	Самый высокий уровень масштаба для слоя, который требуется создать.
minZoom	integer	Самый низкий уровень масштаба для слоя, который требуется создать.

TilesetConfiguration

Поля верхнего уровня конфигурации набора плиток. Конфигурация набора плиток — это объект JSON, который должен содержать следующие поля верхнего уровня:

Имя	Тип	Описание
layers	<string, LayerObject>	Имена слоев и их параметры конфигурации. Объект уровней конфигурации содержит пары "ключ-значение", связывающие имена слоев плиток с их конфигурацией. Для каждой пары "ключ-значение" ключ — это имя слоя, а значение — это объект LayerObject, содержащий конфигурацию и параметры слоя. Каждый слой должен иметь имя. Это уникальный идентификатор слоя данных в окончательном наборе плиток. В любом наборе плиток имя каждого слоя должно быть уникальным. Имя слоя должно быть строкой с символами подчеркивания (_) и буквенно-цифровыми символами. Соответствующий layerObject для каждого имени слоя описывает, как должен быть создан слой векторной плитки. Он указывает, какие классы признаков следует извлекать данные признаков, точность данных с помощью уровней масштабирования и как преобразовывать признаки и преобразовывать их в плитки.
version	integer	Версия ссылки на конфигурацию службы Azure Maps Tiling, которая используется в конфигурации набора плиток. В настоящее время разрешена только версия 1. Использование любой версии, отличной от текущей или предыдущей, приведет к ошибке.

Поделиться через

Tileset - Create

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

Параметры URI

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

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

Ответы

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

AADToken

Примечания

Scopes

subscription-key

SAS Token

Примеры

Create Tileset by providing a Dataset Id

Sample Request

Sample Response

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Feature

LayerObject

TilesetConfiguration

Дополнительные ресурсы