Conversion - Get Operation

リファレンス

サービス:: Maps Creator

API バージョン:: 2.0

を使用して、変換プロセスの状態をチェックします。

Get Operation API は、呼び出し元が変換プロセスの状態をチェックし、値を取得conversionIdできるようにする HTTP GET 要求です。

このパスは、POST /conversions の呼び出しから取得されます。進行中は、HTTP 200 応答コードが追加のヘッダーなしで返されます。その後、ヘッダーが正常に完了すると HTTP 200 応答コード Resource-Location が返されます。

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

URI パラメーター

名前	/	必須	型	説明
geography	path	True	string	このパラメーターは、Azure Maps Creator リソースの場所を指定します。有効な値は、us と eu です。
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	予期しないエラーが発生しました。

名前

型

説明

200 OK

LongRunningOperationResult

操作が実行されているか完了しています。操作が成功した場合は、Resource-Location ヘッダーを使用して結果へのパスを取得します。

ヘッダー

Resource-Location: string

Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

Authorization URLは、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LongRunningOperationResult	Long-Running Operations API の応答モデル。
LroStatus	要求の状態。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

LongRunningOperationResult

Long-Running Operations API の応答モデル。

名前	型	説明
created	string	作成されたタイムスタンプ。
error	ErrorDetail	エラーの詳細。
operationId	string	この実行時間の長い操作の ID。
status	LroStatus	要求の状態。
warning	ErrorDetail	エラーの詳細。

LroStatus

要求の状態。

名前	型	説明
Failed	string	要求に 1 つ以上のエラーがあります。
NotStarted	string	要求はまだ処理を開始していません。
Running	string	要求が処理を開始しました。
Succeeded	string	要求が正常に完了しました。

次の方法で共有

Conversion - Get Operation

URI パラメーター

応答

セキュリティ

AADToken

メモ

スコープ

subscription-key

SAS Token

例

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

要求のサンプル

応答のサンプル

Get the status of an operation which is still running

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

その他のリソース