Tileset - Validate Configuration

Ссылка

Service:: Maps Creator

API Version:: 2023-03-01-preview

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

Отправка запроса на проверку конфигурации

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

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

Параметры 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 создания набора данных .

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

Имя	Обязательно	Тип	Описание
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. Использование любой другой версии текущей или предыдущей версии приведет к ошибке.

Ответы

Имя	Тип	Описание
200 OK	TilesetConfigurationValidationResult	Убедитесь, что запрос конфигурации набора плиток успешно выполнен. Текст ответа содержит результаты проверки.
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 можно использовать, чтобы разрешить приложениям управлять доступом более безопасным способом, чем общий ключ.

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

Type: apiKey
In: header

Примеры

Validates the correctness of a tileset configuration

Sample Request

HTTP

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

{
  "version": 1,
  "layers": {
    "Indoor test": {
      "minZoom": 10,
      "maxZoom": 18,
      "features": {
        "featureClasses": [
          "unit"
        ],
        "filter": [
          "any",
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "conference"
          ],
          [
            "!=",
            [
              "get",
              "featureType"
            ],
            "restroom"
          ]
        ]
      }
    }
  }
}

Sample Response

Status code:: 200

{
  "valid": false,
  "warnings": [],
  "errors": [
    {
      "code": "CustomLayerNameNotSupported",
      "message": "Custom layerName 'Indoor test' is not supported yet.",
      "target": "Indoor test"
    }
  ]
}

Определения

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

ErrorAdditionalInfo

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

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

ErrorCode

Код ошибки проверки.

Имя	Тип	Описание
CustomLayerNameNotSupported	string	Пользовательское имя слоя сейчас не поддерживается.
CustomOntologyNotSupported	string	Пользовательская онтология сейчас не поддерживается. Онтология "Facility-2.0" является поддерживаемой.
DuplicateFeatureClassFound	string	Имя класса признаков должно быть уникальным.
DuplicateLayerNameFound	string	Имя слоя должно быть уникальным.
UndefinedFeatureClasses	string	Класс признаков должен быть определен в определении онтологии, а в имени класса признаков учитывается регистр.

ErrorDetail

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

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

ErrorResponse

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

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

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. Использование любой другой версии текущей или предыдущей версии приведет к ошибке.

TilesetConfigurationValidationResult

Результат проверки конфигурации набора плиток.

Имя	Тип	Описание
errors	ValidationError[]	Список ошибок проверки.
valid	boolean	Результат проверки.
warnings	ValidationWarning[]	Список предупреждений проверки.

ValidationError

Ошибки проверки конфигурации набора плиток.

Имя	Тип	Описание
code	ErrorCode	Код ошибки проверки.
message	string	Сообщение об ошибке проверки.
target	string	Целевой элемент для ошибки проверки.

ValidationWarning