Render - Get Map Tile

Служба:

Maps

Версия API:

1.0

используется для получения плиток карты в векторном или растровом формате, как правило, для интеграции в новый элемент управления картой или пакет SDK.

Примечание

Azure Maps прекращение поддержки службы "Отрисовка версии 1"

Служба Azure Maps Render версии 1 устарела и будет прекращена 17.09.26. Чтобы избежать перебоев в работе служб, все вызовы API render версии 1 должны быть обновлены для использования API рендеринга версии 2 до 17.09.26.

Извлекает плитки карты в векторном или растровом формате, как правило, для интеграции в новый элемент управления картой или пакет SDK. По умолчанию Azure использует плитки векторной карты для своего элемента управления веб-картой (см. статью Уровни масштабирования и сетка плиток).

Примечание. Плитки погоды доступны только через API получения плитки карты версии 2. Мы рекомендуем начать использовать новый API получения плитки карты версии 2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

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

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	TileFormat	Требуемый формат ответа. Возможные значения: png & pbf.
api-version	query	True	string	Номер версии API Azure Maps
layer	query	True	MapTileLayer	Запрошен слой карты. Возможные значения: basic, hybrid, labels и terra.
style	query	True	MapTileStyle	Возвращаемый стиль карты. Возможные значения: main, темный и shaded_relief.
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	Размер возвращаемой плитки карты в пикселях.
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 и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя	Тип	Описание
200 OK	object	Это изображение возвращается после успешного вызова Get Map Tile Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Заголовки Content-Type: string
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.

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

Примечания

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

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. * Управление доступом на основе ролей 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 или с помощью PowerShell, CLI, пакетов AZURE SDK или REST API.

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

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

Тип: apiKey
В: query

SAS Token

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

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

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

Тип: apiKey
В: header

Примеры

Successful Tile Request

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

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

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

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

200

Content-Type: image/png

"{file}"

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
LocalizedMapView	Параметр View (также называемый параметром "регион пользователя") позволяет отображать правильные карты для определенной страны или региона для геополитически спорных регионов. Разные страны или регионы имеют разные представления таких регионов, и параметр View позволяет приложению соответствовать представлению, требуемому для страны или региона, который будет обслуживать приложение. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимыми законами, включая те, которые касаются сопоставления, страны или региона, в которой доступны карты, изображения и другие данные и содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления.
MapTileLayer	Запрошен слой карты. Возможные значения: basic, hybrid, labels и terra.
MapTileSize	Размер возвращаемой плитки карты в пикселях.
MapTileStyle	Возвращаемый стиль карты. Возможные значения: main, темный и shaded_relief.
TileFormat	Требуемый формат ответа. Возможные значения: png & pbf.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

LocalizedMapView

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

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

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

MapTileLayer

Запрошен слой карты. Возможные значения: basic, hybrid, labels и terra.

Имя	Тип	Описание
basic	string	Возвращает плитку, содержащую все признаки карты, включая многоугольник, границы, дороги и метки.
hybrid	string	Возвращает плитку, содержащую границы, дороги и метки, и может быть наложена на другие плитки (например, спутниковые снимки) для создания гибридных плиток.
labels	string	Возвращает плитку только сведений о метки карты.
terra	string	Холст карты с затеняемой плиткой рельефа. Поддерживаются уровни масштабирования от 0 до 6 (включительно). Png является единственным поддерживаемым TileFormat, а доступно только MapTileSize — 512.

MapTileSize

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

Имя	Тип	Описание
256	string	Возвращает плитку 256 х 256 пикселей.
512	string	Возвращает плитку 512 на 512 пикселей.

MapTileStyle

Возвращаемый стиль карты. Возможные значения: main, темный и shaded_relief.

Имя	Тип	Описание
dark	string	Темно-серая версия Azure Maps main стиле. PNG является единственным поддерживаемым элементом TileFormat.
main	string	стиль Azure Maps main
shaded_relief	string	Azure Maps main стиль, завершенный с затеняемого рельефа. Поддерживается layer terra.

TileFormat

Требуемый формат ответа. Возможные значения: png & pbf.

Имя	Тип	Описание
pbf	string	Векторный рисунок в формате pbf. Поддерживает уровни масштабирования от 0 до 22.
png	string	Изображение в формате PNG. Поддерживает уровни масштабирования от 0 до 18.