Render - Get Map Tile

Служба:

Maps

Версия API:

2024-04-01

Используйте для запроса плиток карты в векторном или растровом формате.
API Get Map Tiles позволяет пользователям запрашивать листы карты в векторном или растровом форматах, как правило, для интеграции в элемент управления картой или SDK. Поддерживаемые типы тайлов включают дорожные тайлы Azure Maps и тайлы Weather Radar в реальном времени. По умолчанию Azure Maps Web SDK использует векторные тайлы для рендеринга управления веб-картой.

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

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

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
tilesetId	query	True	TilesetID	Набор плиток — это коллекция растровых или векторных данных, разделенных на единую сетку квадратных плиток на предустановленных уровнях масштабирования. Каждый набор плиток имеет плиток использовать при выполнении запросов. Готовые к использованию тайлсеты, предоставленные Azure Maps, перечислены ниже. Например, microsoft.base.
x	query	True	integer (int32)	Координата X плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom -1]. Дополнительные сведения см. в уровнях масштабирования и сетке плиток.
y	query	True	integer (int32)	Координата Y плитки в сетке масштабирования. Значение должно находиться в диапазоне [0, 2zoom -1]. Дополнительные сведения см. в уровнях масштабирования и сетке плиток.
zoom	query	True	integer (int32)	Уровень масштабирования для требуемой плитки. Дополнительные сведения см. в уровнях масштабирования и сетке плиток.
language	query		string	Язык, в котором должны быть возвращены результаты поиска. Должен быть одним из поддерживаемых тегов языка IETF, не учитывает регистр. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в поддерживаемых языках.
tileSize	query		MapTileSize	Размер возвращаемой плитки карты в пикселях.
timeStamp	query		string (date-time)	Желаемая дата и время запрошенной плитки. Этот параметр должен быть указан в стандартном формате даты и времени (например, 2019-11-14T16:03:00-08:00), как определено ISO 8601. Этот параметр поддерживается только в том случае, если параметр tilesetId имеет одно из приведенных ниже значений. microsoft.weather.infrared.main: мы предоставляем плитки до 3 часов в прошлом. Плитки доступны в 10-минутных интервалах. Мы округляем значение метки времени до ближайшего 10-минутного интервала времени. microsoft.weather.radar.main: мы предоставляем плитки до 1,5 часов в прошлом и до 2 часов в будущем. Плитки доступны в 5-минутных интервалах. Мы округляем значение метки времени до ближайшего 5-минутного интервала времени.
view	query		LocalizedMapView	Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

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

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

Ответы

Имя	Тип	Описание
200 OK	string	Запрос выполнен успешно. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

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

AadToken

Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.

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

Области

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

subscription-key

Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это токен общего доступа, созданный из операции List SAS на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен SAS.

Тип: apiKey
В: header

Примеры

Successful Tile Request

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

HTTP

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

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

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

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).
LocalizedMapView	Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.
MapTileSize	Размер возвращаемой плитки карты в пикселях.
TilesetID	Набор плиток — это коллекция растровых или векторных данных, разделенных на единую сетку квадратных плиток на предустановленных уровнях масштабирования. Каждый набор плиток имеет плиток использовать при выполнении запросов. Готовые к использованию тайлсеты, предоставленные Azure Maps, перечислены ниже. Например, microsoft.base.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

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

LocalizedMapView

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

Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому страной или регионом, которое будет обслуживать ваше приложение. По умолчанию параметр View имеет значение "Unified", даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильно задать параметр View для этого расположения. Кроме того, можно задать параметр View=Auto, который вернет данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая законы, касающиеся картографирования, страны/региона, где доступны карты, изображения и другие данные, а также сторонний контент, к которому вы уполномочены через Azure Maps. Пример: view=IN.

Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений.

Значение	Описание
AE	Объединенные Арабские Эмираты (арабское представление)
AR	Аргентина (Аргентинский вид)
BH	Бахрейн (арабский вид)
IN	Индия (индийский вид)
IQ	Ирак (арабское представление)
JO	Иордания (арабское представление)
KW	Кувейт (арабский вид)
LB	Ливан (арабский вид)
MA	Марокко (Марокко)
OM	Оман (арабский вид)
PK	Пакистан (пакистанский вид)
PS	Палестинский орган (арабское представление)
QA	Катар (арабский вид)
SA	Саудовская Аравия (арабское представление)
SY	Сирия (арабский вид)
US	США of America
YE	Йемен (арабское представление)
Auto	Возвращает данные карты на основе IP-адреса запроса.
Unified	Унифицированное представление (другие)

MapTileSize

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

Размер возвращаемой плитки карты в пикселях.

Значение	Описание
256	Возвращает плитку 256 на 256 пикселей.
512	Возвращает плитку 512 на 512 пикселей.

TilesetID

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

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

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