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

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	Azure Maps API 的版本号。当前版本为 2024-04-01。
tilesetId	query	True	TilesetID	图块集是在预设缩放级别分解为方形图块的统一网格的光栅或矢量数据的集合。每个磁贴集都有一个 tilesetId ，用于发出请求。使用 Azure Maps Creator 创建的图块集的 tilesetId 是通过 Tileset 创建 API 生成的。下面列出了 Azure Maps 提供的现成磁贴集。例如 microsoft.base。

请求头

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

响应

名称	类型	说明
200 OK	MapTileset	确定
Other Status Codes	ErrorResponse	发生了意外错误。

安全性

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 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 ，用于发出请求。使用 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	错误对象。

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	用于设置网格中数据的格式以供交互的 mustache 模板。
tilejson	string	描述由此 JSON 对象实现的 TileJSON 规范的版本。
tiles	string[]	磁贴终结点的数组。如果指定了多个终结点，则客户端可以使用终结点的任意组合。所有终结点必须为同一 URL 返回相同的内容。数组必须至少包含一个终结点。
version	string	图块集中包含的磁贴的 semver.org 样式版本号。引入跨磁贴的更改时，次要版本必须更改。

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) 。

通过