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

Conversion - Get Operation

用于检查转换过程的状态。

注释

Azure Maps Creator 停用

Azure Maps Creator 室内地图服务现已弃用,将于 2025 年 9 月 30 日停用。 有关详细信息,请参阅 Azure Maps Creator 生命周期结束公告

Get Operation API 是一个 HTTP GET 请求,允许调用方检查 转换 进程的状态并检索 conversionId 值。

将从对 POST /conversions 的调用中获取此路径。 正在进行时,HTTP 200 响应代码将返回,且没有额外的标头 - 后跟 HTTP 200 响应代码,并在成功完成后返回具有 Resource-Location 标头的 HTTP 200 响应代码。

GET https://{geography}.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0

URI 参数

名称 必需 类型 说明
geography
path True

string

此参数指定 Azure Maps Creator 资源所在的位置。 有效值是我们和欧盟。

operationId
path True

string

查询转换创建/导入请求的状态的 ID。

api-version
query True

string

Azure Maps API 的版本号。

响应

名称 类型 说明
200 OK

LongRunningOperationResult

该作正在运行或完成。 如果作成功,请使用 Resource-Location 标头获取结果的路径。

标头

Resource-Location: string

Other Status Codes

ErrorResponse

发生意外错误。

安全性

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 允许为多个用例设置基于应用程序的配置。

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

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

类型: apiKey
在: header

示例

Get the status of an operation which has finished successfully, with non-fatal warnings
Get the status of an operation which is still running

Get the status of an operation which has finished successfully, with non-fatal warnings

示例请求

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

示例响应

Resource-Location: https://us.atlas.microsoft.com/conversions/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",
  "warning": {
    "code": "dwgConversionProblem",
    "details": [
      {
        "code": "warning",
        "details": [
          {
            "code": "manifestWarning",
            "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False"
          }
        ]
      }
    ]
  }
}

Get the status of an operation which is still running

示例请求

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

示例响应

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

LongRunningOperationResult

Long-Running作 API 的响应模型。

LroStatus

请求的状态状态。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

LongRunningOperationResult

Long-Running作 API 的响应模型。

名称 类型 说明
created

string (date-time)

创建的时间戳。

error

ErrorDetail

错误详细信息。

operationId

string

此长时间运行的作的 ID。

status

LroStatus

请求的状态状态。

warning

ErrorDetail

错误详细信息。

LroStatus

请求的状态状态。

说明
Failed

请求有一个或多个失败。

NotStarted

请求尚未开始处理。

Running

请求已开始处理。

Succeeded

请求已成功完成。