Render - Get Map Imagery Tile
返回大小为 256x256 的地图图像磁贴,给定 x 和 y 坐标和缩放级别,范围从 1 到 19。
注释
Azure Maps 呈现 v1 服务停用
Azure Maps Render v1 服务现已弃用,将于 9/17/26 停用。 为了避免服务中断,需要更新对 Render v1 API 的所有调用,以使用 9/17/26 的 最新版本 的呈现 API。
当前可用的样式值为“卫星”,仅提供卫星图像。
#B0 注意 #A1:建议开始使用新的 #B2 获取地图图块 V2 API #A3。
GET https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom={zoom}&x={x}&y={y}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
format
|
path | True |
响应的所需格式。 可能的值:png。 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
style
|
query | True |
要返回的地图样式。 #B0 可能的值:#C1 卫星。 |
|
x
|
query | True |
integer (int32) |
缩放网格上磁贴的 X 坐标。 值必须位于 [0, 2 有关详细信息,请参阅 缩放级别和磁贴网格。 |
y
|
query | True |
integer (int32) |
缩放网格上磁贴的 Y 坐标。 值必须位于 [0, 2 有关详细信息,请参阅 缩放级别和磁贴网格。 |
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/json", "image/jpeg", "image/png" 标头 Content-Type: string |
Other Status Codes |
发生意外错误。 Media Types: "application/json", "image/jpeg", "image/png" |
安全性
AADToken
这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时, 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST 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 资源
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,建议在 映射帐户资源 上配置允许的源的特定列表,以限制呈现滥用并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Successful Imagery Tile Request
示例请求
GET https://atlas.microsoft.com/map/imagery/png?api-version=1.0&style=satellite&zoom=6&x=10&y=22
示例响应
Content-Type: image/png
"{file}"
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Map |
要返回的地图样式。 #B0 可能的值:#C1 卫星。 |
Raster |
响应的所需格式。 可能的值:png。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
MapImageryStyle
要返回的地图样式。 #B0 可能的值:#C1 卫星。
值 | 说明 |
---|---|
satellite |
卫星图像 |
RasterTileFormat
响应的所需格式。 可能的值:png。
值 | 说明 |
---|---|
png |
采用 png 格式的图像。 支持缩放级别 0 到 18。 |