你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Data - Download
使用 下载以前使用数据上传上传 的数据。
注意
Azure Maps 数据服务停用
Azure Maps 数据服务（v1 和 v2）现已弃用，并将于 2024 年 9 月 16 日开始停用。 为了避免服务中断，对数据服务的所有调用都需要在 2024 年 9 月 16 日之前更新为使用 Azure Maps 数据注册表服务。 有关详细信息，请参阅如何创建数据注册表。
API Data Download 是 和 HTTP GET 请求，允许调用方下载以前上传的数据内容。
可以在以下方案中使用此 API：下载之前使用数据上传 API 上传的现有地理围栏集合，以便在Azure Maps地理围栏服务中使用。
重要
使用此功能即表示你同意预览版法律条款。 有关更多详细信息，请参阅 预览版补充条款 。
提交下载请求
若要下载内容，你将使用请求 GET ，其中路径将包含 udid 要下载的数据的 。 （可选）还可以传入 Accept 标头，以指定数据响应的 首选项 Content-Type 。
例如，若要下载以前使用上传 API 上传的地理围栏集合，请将路径中的 参数设置为udidudid之前在上传 API 响应中收到的数据的 ，并将标头设置为Accept以下媒体类型之一：
application/jsonapplication/vnd.geo+jsonapplication/octet-stream
下载数据响应
如果找到具有传入udid项的数据资源，则下载 API 将返回 HTTP 200 OK 响应，其中响应正文将包含数据资源的内容。
如果未找到传入的数据资源，udid将返回 HTTP 400 Bad Request 错误响应。
下面是先前使用上传 API 上传的简单 GeoJSON 地理围栏的示例响应正文：
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [-122.126986, 47.639754]
},
"properties": {
"geometryId": "001",
"radius": 500
}
}]
}
GET https://{geography}.atlas.microsoft.com/mapData/{udid}?api-version=2.0URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
geography
|
path | True |
string |
此参数指定 Azure Maps Creator 资源所在的位置。 有效值是 us 和 eu。 |
|
udid
|
path | True |
string |
内容的唯一数据 ID。 |
|
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 |
file |
数据下载请求已成功完成。 响应正文将包含 传入的 Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" Headers Content-Type: string |
| Other Status Codes |
发生了意外错误。 Media Types: "application/json", "application/vnd.geo+json", "application/octet-stream" |
安全性
AADToken
这些是 OAuth 2.0 流Microsoft Entra。 与 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 标识平台概述。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名称 | 说明 |
|---|---|
| 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，以便安全地存储密钥。
Type:
apiKey
In:
query
SAS Token
这是一个共享访问签名令牌，通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。
使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序，我们建议在 映射帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。
Type:
apiKey
In:
header
示例
Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences
Sample Request
GET https://us.atlas.microsoft.com/mapData/25084fb7-307a-4720-8f91-7952a0b91012?api-version=2.0
Sample Response
"{file}"定义
| 名称 | 说明 |
|---|---|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |