Render - Get Map Tileset

Ссылка

Служба:: Maps

Версия API:: 2024-04-01

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

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

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId={tilesetId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Номер версии API Azure Maps Текущая версия — 01.04.2024.
tilesetId	query	True	TilesetID	Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.

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

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

Ответы

Имя	Тип	Описание
200 OK	MapTileset	ОК
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечания

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

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

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

Тип: 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 с помощью портала Azure, PowerShell, CLI, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: header

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successful Tileset Request

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

HTTP

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

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

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

{
  "tilejson": "2.2.0",
  "version": "1.0.0",
  "attribution": "<a data-azure-maps-attribution-tileset=\"microsoft.base\">&copy;2022 TomTom</a>",
  "scheme": "xyz",
  "tiles": [
    "https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}"
  ],
  "minzoom": 0,
  "maxzoom": 22,
  "bounds": [
    -180,
    -90,
    180,
    90
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
MapTileset	Метаданные для набора плиток в формате TileJSON.
TilesetID	Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

MapTileset

Метаданные для набора плиток в формате TileJSON.

Имя	Тип	Описание
attribution	string	Авторские права, отображаемые на карте. Реализации МОГУТ рассматривать это как HTML или литеральный текст. Из соображений безопасности убедитесь, что это поле не может использоваться в качестве вектора для отслеживания XSS или маяка.
bounds	number[]	Максимальный объем доступных плиток карты. Границы ДОЛЖНЫ определять область, покрываемую всеми уровнями масштабирования. Границы представлены в значениях широты и долготы WGS:84 в порядке слева, внизу, справа, сверху. Значения могут быть целыми числами или числами с плавающей запятой.
center	number[]	Расположение набора плиток по умолчанию в формате [долгота, широта, масштаб]. Уровень масштабирования должен находиться между minzoom и maxzoom. Реализации могут использовать это значение для задания расположения по умолчанию.
data	string[]	Массив файлов данных в формате GeoJSON.
description	string	Текстовое описание набора плиток. Описание может содержать любой юридический символ. Реализации НЕ ДОЛЖНЫ интерпретировать описание как HTML.
grids	string[]	Массив интерактивных конечных точек.
legend	string	Легенда, отображаемая вместе с картой. Реализации МОГУТ рассматривать это как HTML или литеральный текст. Из соображений безопасности убедитесь, что это поле не может использоваться в качестве вектора для отслеживания XSS или маяка.
maxzoom	integer	Максимальный уровень масштаба.
minzoom	integer	Минимальный уровень масштабирования.
name	string	Имя, описывающее набор плиток. Имя может содержать любой юридический символ. Реализации НЕ ДОЛЖНЫ интерпретировать имя как HTML.
scheme	string	Значение по умолчанию: "xyz". Либо "xyz", либо "tms". Влияет на направление координат плитки по оси Y. Предполагается профиль глобального меркатора (он же сферический меркатор).
template	string	Шаблон усов, используемый для форматирования данных из сетки для взаимодействия.
tilejson	string	Описывает версию спецификации TileJSON, реализованную этим объектом JSON.
tiles	string[]	Массив конечных точек плитки. Если указано несколько конечных точек, клиенты могут использовать любое сочетание конечных точек. Все конечные точки ДОЛЖНЫ возвращать одно и то же содержимое для одного URL-адреса. Массив должен содержать по крайней мере одну конечную точку.
version	string	Номер версии стиля semver.org для плиток, содержащихся в наборе плиток. При внесении изменений в плитках необходимо изменить дополнительную версию.

TilesetID

Набор плиток — это коллекция растровых или векторных данных, разбитая на однородную сетку квадратных плиток с предустановленными уровнями масштаба. Каждый набор плиток имеет tilesetId , используемый при выполнении запросов. TilesetId для наборов плиток, созданных с помощью Azure Maps Creator, создаются с помощью API создания набора плиток. Ниже перечислены готовые наборы плиток, предоставляемые Azure Maps. Например, microsoft.base.

Имя	Тип	Описание
microsoft.base	string	Базовая карта — это стандартная карта, отображающая дороги, природные и искусственные признаки, а также метки для этих признаков в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.darkgrey	string	Все слои с нашим темно-серым стилем. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.hybrid	string	Отображает данные дороги, границы и метки в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Данные дорог, границ и меток в нашем темно-сером стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.hybrid.road	string	Данные дорог, границ и меток в нашем основном стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.labels	string	Отображает метки для дорог, естественных и искусственных признаков в векторной плитке. Поддерживает уровни масштабирования от 0 до 22. Формат: vector (pbf).
microsoft.base.labels.darkgrey	string	Пометка данных в нашем темно-сером стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.labels.road	string	Пометка данных в основном стиле. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.base.road	string	Все слои с нашим основным стилем. Поддерживает уровни масштабирования от 0 до 22. Формат: растровый (png).
microsoft.imagery	string	Сочетание спутниковых и аэроснимков. Доступно только в ценовом номере SKU S1. Поддерживает уровни масштабирования от 1 до 19. Формат: растровый (jpeg).
microsoft.terra.main	string	Затенение рельефа и слои терры. Поддерживает уровни масштаба от 0 до 6. Формат: растровый (png).
microsoft.traffic.absolute	string	плитки абсолютного трафика в векторе
microsoft.traffic.absolute.main	string	плитки абсолютного трафика в растре в нашем основном стиле.
microsoft.traffic.delay	string	плитки трафика в векторе
microsoft.traffic.delay.main	string	плитки трафика в растре в нашем основном стиле
microsoft.traffic.incident	string	плитки инцидентов в векторе
microsoft.traffic.reduced.main	string	плитки с уменьшенным трафиком в растре в нашем основном стиле
microsoft.traffic.relative	string	плитки относительного трафика в векторе
microsoft.traffic.relative.dark	string	плитки относительного трафика в растре в нашем темном стиле.
microsoft.traffic.relative.main	string	плитки относительного трафика в растре в нашем основном стиле.
microsoft.weather.infrared.main	string	Плитки с инфракрасной погодой. Последние инфракрасные спутниковые снимки показывают облака по их температуре. Дополнительные сведения см. в статье Покрытие метеорологических служб Azure Maps. Дополнительные сведения о возвращаемых спутниковых данных см. в статье Службы погоды в Azure Maps. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png).
microsoft.weather.radar.main	string	Плитки метеорологического радара. Последние изображения метеорологических радаров, включая области дождя, снега, льда и смешанных условий. Дополнительные сведения о покрытии службы погоды Azure Maps см. в статье Покрытие метеорологических служб Azure Maps. Дополнительные сведения о данных радаров см. в статье Службы погоды в Azure Maps. Поддерживает уровни масштабирования от 0 до 15. Формат: растровый (png).

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