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

Tileset - List

参考

服务:: Maps Creator

API 版本:: 2.0

用于获取磁贴集的列表。

注释

Azure Maps Creator 停用

Azure Maps Creator 室内地图服务现已弃用，将于 2025 年 9 月 30 日停用。有关详细信息，请参阅 Azure Maps Creator 生命周期结束公告。

提交列表请求

List API 是一个 HTTP GET 请求，用于提取所有现有磁贴集的列表。

GET https://{geography}.atlas.microsoft.com/tilesets?api-version=2.0

URI 参数

名称	在	必需	类型	说明
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。有效值是我们和欧盟。
api-version	query	True	string	Azure Maps API 的版本号。

请求头

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

响应

名称	类型	说明
200 OK	TilesetListResult	列表磁贴集请求已成功完成。响应正文包含所有磁贴集的列表。
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 Maps 帐户时预配的共享密钥。

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

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

类型: apiKey
在: query

SAS Token

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

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

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

类型: apiKey
在: header

示例

Get a list of all tilesets

示例请求

HTTP

GET https://us.atlas.microsoft.com/tilesets?api-version=2.0

示例响应

状态代码:: 200

{
  "tilesets": [
    {
      "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84",
      "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b",
      "description": "My first tileset",
      "minZoom": 16,
      "maxZoom": 18,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ]
    },
    {
      "tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3",
      "datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad",
      "description": "My second tileset",
      "minZoom": 19,
      "maxZoom": 19,
      "bbox": [
        -122.13595,
        47.636524,
        -122.1329,
        47.637525
      ]
    }
  ]
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
Tileset	数据的详细信息。
TilesetListResult	磁贴集列表 API 的响应模型。返回所有磁贴集的列表。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

Tileset

Object

数据的详细信息。

名称	类型	说明
bbox	number[] (double)	图块集的所有功能的边界框位于其中。使用的投影 - EPSG：3857。格式：“minLon、minLat、maxLon、maxLat”。
datasetId	string	用于创建磁贴集的唯一数据集 ID。
description	string	创建图块集时提供的调用方的说明。最大长度为 1024 个字符。
maxZoom	integer	为图块集生成的最高磁贴缩放级别磁贴。
minZoom	integer	为图块集生成的最低磁贴缩放级别磁贴。
ontology	string	此数据集的本体版本。
tilesetId	string	磁贴集的唯一磁贴集 ID。

TilesetListResult

Object

磁贴集列表 API 的响应模型。返回所有磁贴集的列表。

名称	类型	说明
nextLink	string	如果存在，则为下一页数据的位置。
tilesets	Tileset[]	所有图块集的列表。

通过

Tileset - List

提交列表请求

URI 参数

请求头

响应

安全性

AADToken

备注

作用域

subscription-key

SAS Token

示例

Get a list of all tilesets

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

Tileset

TilesetListResult

其他资源