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

Render - Get Map State Tile

服务:

Maps

API 版本:

2024-04-01

使用 获取矢量格式的状态磁贴，然后可用于在室内地图中显示特征状态信息。

提取矢量格式的状态图块，通常要集成到地图控件或 SDK 的室内地图模块中。 地图控件将在用户打开动态样式设置后调用此 API。 有关详细信息，请参阅 缩放级别和磁贴网格。

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

URI 参数

名称	在	必需	类型	说明
api-version	query	True	string	Azure Maps API 的版本号。 当前版本为 2024-04-01。
statesetId	query	True	string	状态集 ID。
x	query	True	integer int32	缩放网格上磁贴的 X 坐标。 值必须在 [0， 2zoom -1] 范围内。 有关详细信息 ，请参阅缩放级别和磁贴网格 。
y	query	True	integer int32	缩放网格上磁贴的 Y 坐标。 值必须在 [0， 2zoom -1] 范围内。 有关详细信息 ，请参阅缩放级别和磁贴网格 。
zoom	query	True	integer int32	所需磁贴的缩放级别。 有关详细信息 ，请参阅缩放级别和磁贴网格 。

请求头

名称	必需	类型	说明
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/vnd.mapbox-vector-tile", "application/json" 标头 Content-Type: string
Other Status Codes	ErrorResponse	发生了意外错误。 Media Types: "application/vnd.mapbox-vector-tile", "application/json"

安全性

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

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

类型: apiKey
在: header

示例

Successful State Tile Request

示例请求

HTTP

GET https://atlas.microsoft.com/map/statetile?api-version=2024-04-01&zoom=6&x=10&y=22&statesetId=[statesetId]

示例响应

状态代码:

200

Content-Type: application/vnd.mapbox-vector-tile

"{file}"

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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