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

Render - Get Map Tile

服务:

Maps

API 版本:

1.0

用于获取通常要集成到新地图控件或 SDK 中的矢量或光栅格式的地图图块。

注意

Azure Maps 呈现 v1 服务停用

Azure Maps Render v1 服务现已弃用，将于 26 年 9 月 17 日停用。 为了避免服务中断，所有对 Render v1 API 的调用都需要更新为在 26 年 9 月 17 日使用 Render v2 API。

提取通常要集成到新地图控件或 SDK 中的矢量或光栅格式的地图图块。 默认情况下，Azure 将矢量地图图块用于其 Web 地图控件 (请参阅 缩放级别和图块网格)

注意：天气磁贴只能通过 获取地图图块 V2 API 获取。 建议开始使用新的 获取地图图块 V2 API。

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	Azure Maps API 的版本号。
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 地址返回地图数据。 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	此图像是从成功的“获取地图图块”调用返回的 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
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 门户或使用 PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

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

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

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

类型: apiKey
在: header

示例

Successful Tile Request

Sample request

HTTP

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

Sample response

Status code:

200

Content-Type: image/png

"{file}"

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
LocalizedMapView	View 参数 (也称为“用户区域”参数) 允许你为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区对此类区域有不同的视图，并且 View 参数允许应用程序符合应用程序将服务的国家/地区所需的视图。 默认情况下，View 参数设置为“Unified”，即使尚未在请求中定义它。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括与地图、图像和其他数据以及你有权通过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 地址返回地图数据。 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	也门（阿拉伯视图）

MapTileLayer

请求的地图层。 可能的值为 basic、hybrid、labels 和 terra。

名称	类型	说明
basic	string	返回一个图块，其中包含所有地图特征，包括多边形、边框、道路和标签。
hybrid	string	返回包含边框、道路和标签的磁贴，并且可以叠加在其他磁贴上， (如卫星图像) 以生成混合磁贴。
labels	string	仅返回地图标签信息的图块。
terra	string	带有阴影浮雕图块的地图画布。 支持缩放级别 0-6 (（含) ）。 Png 是唯一支持的 TileFormat，并且只有可用的 MapTileSize 为 512。

MapTileSize

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

名称	类型	说明
256	string	返回 256 x 256 像素磁贴。
512	string	返回 512 x 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。