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

Render - Get Map Tileset

用于获取磁贴集的元数据。

获取地图图块集 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 提供的现成使用磁贴集。 例如,microsoft.base。

请求头

名称 必需 类型 说明
x-ms-client-id

string

指示用于 Microsoft Entra ID 安全模型的帐户。 可以从 Azure Maps 管理平面帐户 API 获取 Azure Maps 帐户的唯一 ID。 有关在 Azure Maps 中使用 Microsoft Entra ID 安全性的详细信息,请参阅 在 Azure Maps 中管理身份验证

响应

名称 类型 说明
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 允许为多个用例设置基于应用程序的配置。

类型: 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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

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

类型: apiKey
在: header

示例

Successful Tileset Request

示例请求

GET https://atlas.microsoft.com/map/tileset?api-version=2024-04-01&tilesetId=microsoft.base

示例响应

{
  "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 提供的现成使用磁贴集。 例如,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

minimum: 0
maximum: 30

最大缩放级别。

minzoom

integer

minimum: 0
maximum: 30

最小缩放级别。

name

string

描述磁贴集的名称。 该名称可以包含任何法律字符。 实现不应将名称解释为 HTML。

scheme

string

默认值:“xyz”。 “xyz”或“tms”。 影响图块坐标的 y 方向。 假定全局-墨卡托(即球面墨卡托)配置文件。

template

string

用于设置来自网格的数据进行交互的格式的胡须模板。

tilejson

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

描述此 JSON 对象实现的 TileJSON 规范的版本。

tiles

string[]

磁贴终结点数组。 如果指定了多个终结点,客户端可以使用任意组合的终结点。 所有终结点必须返回相同 URL 的相同内容。 数组必须至少包含一个终结点。

version

string

pattern: \d+\.\d+\.\d+\w?[\w\d]*

磁贴集中包含的磁贴的 semver.org 样式版本号。 引入跨磁贴的更改时,次要版本必须更改。

TilesetID

图块集是一组光栅或矢量数据,按照预设的缩放级别被划分为统一的方形图块网格。 每个图块集都有一个在发出请求时要使用的 tilesetId。 下面列出了 Azure Maps 提供的现成使用磁贴集。 例如,microsoft.base。

说明
microsoft.base

基本地图是一种标准地图,它显示道路、自然特征和人工特征以及矢量图块中这些功能的标签。

支持缩放级别 0 到 22。 格式:矢量(pbf)。

microsoft.base.labels

在矢量磁贴中显示道路、自然和人工特征的标签。

支持缩放级别 0 到 22。 格式:矢量(pbf)。

microsoft.base.hybrid

在矢量图块中显示道路、边界和标签数据。

支持缩放级别 0 到 22。 格式:矢量(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 天气服务覆盖范围的详细信息,请参阅 Azure Maps 天气服务覆盖范围。 有关雷达数据的详细信息,请参阅 Azure Maps 中的天气服务

支持缩放级别 0 到 15。 格式:光栅(png)。

microsoft.weather.infrared.main

天气红外磁贴。 最新的红外卫星图像按温度显示云。 有关详细信息,请参阅 Azure Maps 天气服务覆盖范围。 有关返回的卫星数据的详细信息,请参阅 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

矢量中的事件磁贴