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安全的更多信息，请参见管理认证在Azure Maps。

响应

名称	类型	说明
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 SDKs或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 Maps资源时，通过Azure门户、PowerShell、CLI、Azure SDKs或REST API在Azure管理层中配置。

使用此密钥，任何应用程序都有权访问所有 REST API。 换句话说，这些密钥当前可视为为其颁发的帐户的主密钥。

对于公开暴露的应用，我们建议使用服务器间访问 Azure Maps REST API，以便安全地存储该密钥。

类型: apiKey
在: header

SAS Token

这是一个共享访问签名令牌，通过Azure Maps资源的列表SAS作，通过Azure门户、PowerShell、CLI、Azure SDKs或REST API通过Azure管理层创建。

通过该令牌，任何应用程序都被授权通过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	错误对象。