你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Conversion - Convert
用于将以前导入的 绘图包 转换为地图数据。
API Conversion
是一个 HTTP POST
请求,允许调用方将一组 DWG 设计文件作为压缩的绘图包导入Azure Maps。 绘图包被 udid
上传到 数据注册表时使用的 引用。 有关数据注册表服务的详细信息,请参阅 如何创建数据注册表。
转换 DWG 包
转换 API 执行 长时间运行的操作。
调试 DWG 包问题
在转换过程中,如果 DWG 包出现任何问题,响应中会提供 警告以及 用于可视化和诊断这些问题的 诊断包 。 如果 DWG 包遇到任何问题, 此处 详述的转换操作状态过程将返回诊断包的位置,调用方可以下载该诊断 包 ,以帮助他们可视化和诊断这些问题。 可以在转换操作状态响应的 properties 节中找到 诊断包 位置,如下所示:
{
"properties": {
"diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"
}
}
可以通过对 diagnosticPackageLocation
执行HTTP GET
请求来下载诊断包。
有关如何使用该工具可视化和诊断所有错误和警告的详细信息,请参阅 绘制错误可视化工具。
如果有零个或多个警告,转换操作将标记为 成功 ,但如果遇到任何错误,则会标记为 失败 。
POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0
POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0&description={description}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
geography
|
path | True |
string |
此参数指定 Azure Maps Creator 资源所在的位置。 有效值为 us 和 eu。 |
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
output
|
query | True |
输出本体版本。 “facility-2.0”是目前唯一支持的值。 有关Azure Maps Creator 本体的详细信息,请参阅此文。 |
|
udid
|
query | True |
string |
内容的唯一数据 ID ( |
description
|
query |
string |
用户提供了要转换的内容的说明。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定要与Microsoft Entra ID安全模型结合使用的帐户。 它表示Azure Maps帐户的唯一 ID,可从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性,请参阅以下文章以获取指导。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
操作正在运行或已完成。 如果操作成功,请使用 Resource-Location 标头获取结果的路径。 标头 Resource-Location: string |
|
202 Accepted |
请求已接受:已接受请求进行处理。 请使用 Operation-Location 标头中的 URL 获取状态。 标头 Operation-Location: string |
|
Other Status Codes |
发生了意外错误。 |
安全性
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 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 Map 帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
类型:
apiKey
在:
header
示例
Convert previously uploaded DWG Package
示例请求
POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0
示例响应
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
{
"operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"created": "2021-04-20T22:43:14.9401559+00:00",
"status": "Succeeded"
}
Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
定义
名称 | 说明 |
---|---|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Long |
Long-Running 操作 API 的响应模型。 |
Lro |
请求的状态状态。 |
Output |
输出本体版本。 “facility-2.0”是目前唯一支持的值。 有关Azure Maps Creator 本体的详细信息,请参阅此文。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
LongRunningOperationResult
Long-Running 操作 API 的响应模型。
名称 | 类型 | 说明 |
---|---|---|
created |
string |
创建的时间戳。 |
error |
错误详细信息。 |
|
operationId |
string |
此长时间运行的操作的 ID。 |
status |
请求的状态状态。 |
|
warning |
错误详细信息。 |
LroStatus
请求的状态状态。
名称 | 类型 | 说明 |
---|---|---|
Failed |
string |
请求有一个或多个失败。 |
NotStarted |
string |
请求尚未开始处理。 |
Running |
string |
请求已开始处理。 |
Succeeded |
string |
请求已成功完成。 |
OutputOntology
输出本体版本。 “facility-2.0”是目前唯一支持的值。 有关Azure Maps Creator 本体的详细信息,请参阅此文。
名称 | 类型 | 说明 |
---|---|---|
facility-2.0 |
string |
Facility Ontology 定义了 Azure Maps Creator 内部在 Creator 数据集中存储设施数据的方式。 |