你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Render - Get Map Tile

服务:

Maps

API 版本:

2024-04-01

用于请求矢量或光栅格式的地图图块。

Get Map Tiles HTTP GET 请求中的 API，允许用户请求通常集成到地图控件或 SDK 中的矢量或光栅格式的地图图块。 可以请求的一些示例磁贴是 Azure Maps 道路图块、实时天气雷达图块或使用 Azure Maps Creator 创建的地图图块。 默认情况下，Azure Maps 将矢量图块用于其 Web 地图控件， (Web SDK) 和 Android SDK。

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

具有可选参数:

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	Azure Maps API 的版本号。 当前版本为 2024-04-01。
tilesetId	query	True	TilesetID	图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个磁贴集都有一个 tilesetId ，用于发出请求。 使用 Azure Maps Creator 创建的图块集的 tilesetId 是通过 Tileset 创建 API 生成的。 下面列出了 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 分钟。 我们将 timeStamp 值舍入为最接近的 10 分钟时间范围。 microsoft.weather.radar.main：过去提供长达 1.5 小时的磁贴，未来最多提供 2 小时的磁贴。 磁贴每 5 分钟可用一次。 我们将 timeStamp 值舍入为最接近的 5 分钟时间范围。
view	query		LocalizedMapView	View 参数 (也称为“用户区域”参数) 允许你为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图，并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下，View 参数设置为“Unified”，即使尚未在请求中定义它。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括有关地图、图像和其他数据以及你有权通过 Azure Maps 访问的第三方内容的国家/地区的法律。 示例：view=IN。 有关详细信息和可用的 视图 ，请参阅支持的视图。

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定用于与 Microsoft Entra ID 安全模型结合使用的帐户。 它表示 Azure Maps 帐户的唯一 ID，可从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下 文章 以获取指导。

响应

名称	类型	说明
200 OK	object	从成功的 API 调用返回的磁贴。 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 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。 * 使用 Azure Maps Web SDK 可以针对多个用例对应用程序进行基于配置的设置。

• 有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

这是在通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面创建 Azure Maps 资源 时预配的共享密钥。

使用此密钥，任何应用程序都有权访问所有 REST API。 换而言之，这些密钥当前可被视为为其颁发帐户的主密钥。

对于公开的应用程序，我们建议使用 Azure Maps REST API 的服务器到服务器访问，以便安全地存储此密钥。

类型: apiKey
在: header

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源 上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 Map 帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

Successful Tile Request

示例请求

HTTP

GET https://atlas.microsoft.com/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	错误响应
LocalizedMapView	View 参数 (也称为“用户区域”参数) 允许你为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图，并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下，View 参数设置为“Unified”，即使尚未在请求中定义它。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括有关地图、图像和其他数据以及你有权通过 Azure Maps 访问的第三方内容的国家/地区的法律。 示例：view=IN。 有关详细信息和可用的 视图 ，请参阅支持的视图。
MapTileSize	返回的地图图块的大小（以像素为单位）。
TilesetID	图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个磁贴集都有一个 tilesetId ，用于发出请求。 使用 Azure Maps Creator 创建的图块集的 tilesetId 是通过 Tileset 创建 API 生成的。 下面列出了 Azure Maps 提供的现成磁贴集。 例如 microsoft.base。

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 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括有关地图、图像和其他数据以及你有权通过 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	也门（阿拉伯视图）

MapTileSize

返回的地图图块的大小（以像素为单位）。

名称	类型	说明
256	string	返回 256 x 256 像素磁贴。
512	string	返回 512 x 512 像素磁贴。

TilesetID

图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。 每个磁贴集都有一个 tilesetId ，用于发出请求。 使用 Azure Maps Creator 创建的图块集的 tilesetId 是通过 Tileset 创建 API 生成的。 下面列出了 Azure Maps 提供的现成磁贴集。 例如 microsoft.base。

名称	类型	说明
microsoft.base	string	基本地图是一种标准地图，可在矢量图块中显示道路、自然特征和人工特征以及这些特征的标签。 支持缩放级别 0 到 22。 格式：矢量 (pbf) 。
microsoft.base.darkgrey	string	所有采用深灰色样式的层。 支持缩放级别 0 到 22。 格式：光栅 (png) 。
microsoft.base.hybrid	string	在矢量图块中显示道路、边界和标签数据。 支持缩放级别 0 到 22。 格式：矢量 (pbf) 。
microsoft.base.hybrid.darkgrey	string	深灰色样式的道路、边界和标签数据。 支持缩放级别 0 到 22。 格式：光栅 (png) 。
microsoft.base.hybrid.road	string	主要样式中的道路、边界和标签数据。 支持缩放级别 0 到 22。 格式：光栅 (png) 。
microsoft.base.labels	string	在矢量图块中显示道路、自然特征和人工特征的标签。 支持缩放级别 0 到 22。 格式：矢量 (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	卫星和航空图像的组合。 仅在 S1 定价 SKU 中可用。 支持缩放级别 1 到 19。 格式：光栅 (jpeg) 。
microsoft.terra.main	string	阴影浮雕和 terra 层。 支持缩放级别 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) 。