Conversion - Convert

リファレンス

Service:: Maps Creator

API Version:: 2.0

以前にインポートした図面パッケージをマップデータに変換するには、を使用します。

Conversion API は HTTP POST 要求であり、呼び出し元は DWG デザインファイルのセットを zip 形式の描画パッケージとしてAzure Mapsにインポートできます。図面パッケージは、データレジストリにアップロードされたときに使用されるによってudid参照されます。データレジストリサービスの詳細については、「データレジストリを作成する方法」を参照してください。

DWG パッケージを変換する

Conversion API は実行時間の長い操作を実行します。

DWG パッケージの問題をデバッグする

変換プロセス中に、DWG パッケージのエラーと警告に問題がある場合は、これらの問題を視覚化して診断するための 診断パッケージ と共に応答で提供されます。 DWG パッケージで問題が発生した場合、ここで説明するように変換操作の状態プロセスは、呼び出し元がこれらの問題を視覚化して診断するのに役立つ 診断パッケージ の場所を返します。 診断パッケージの場所は、変換操作の状態応答の properties セクションにあります。次のようになります。

{
    "properties": {
        "diagnosticPackageLocation": "https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0"                
    }            
}

診断パッケージは、でdiagnosticPackageLocation要求をHTTP GET実行することでダウンロードできます。ツールを使用してすべてのエラーと警告を視覚化および診断する方法の詳細については、「 Drawing Error Visualizer」を参照してください。

0 個以上の警告がある場合、変換操作は成功としてマークされますが、エラーが発生した場合は失敗としてマークされます。

POST https://{geography}.atlas.microsoft.com/conversions?api-version=2.0&udid={udid}&outputOntology=facility-2.0

With optional parameters:

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 のバージョン番号。
outputOntology	query	True	OutputOntology	出力オントロジバージョン。現時点でサポートされている値は "facility-2.0" のみです。 Azure Maps Creator のオントロジの詳細については、こちらの記事を参照してください。
udid	query	True	string	コンテンツの一意のデータ ID (`udid`)。データレジストリの作成時に使用するのと同じである`udid`必要があります。
description	query		string	変換されるコンテンツの説明をユーザーが指定しました。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

応答

名前	型	説明
200 OK	LongRunningOperationResult	操作が実行されているか完了しています。操作が成功した場合は、Resource-Location ヘッダーを使用して結果へのパスを取得します。 Headers Resource-Location: string
202 Accepted		[Request Accepted]\(要求の承諾\): 要求は処理のために受け入れ済みです。状態を取得するには、Operation-Location ヘッダーの URL を使用してください。 Headers Operation-Location: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

名前

型

説明

200 OK

LongRunningOperationResult

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

Headers

Resource-Location: string

202 Accepted

[Request Accepted]\(要求の承諾\): 要求は処理のために受け入れ済みです。状態を取得するには、Operation-Location ヘッダーの URL を使用してください。

Headers

Operation-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 プラットフォームの概要」を参照してください。

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

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

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

Type: apiKey
In: query

SAS Token

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

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

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Convert previously uploaded DWG Package

Sample Request

HTTP

POST https://us.atlas.microsoft.com/conversions?api-version=2.0&udid=25084fb7-307a-4720-8f91-7952a0b91012&outputOntology=facility-2.0

Sample Response

Status code:: 200

Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

Response Body

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}

Status code:: 202

Operation-Location: https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LongRunningOperationResult	Long-Running Operations API の応答モデル。
LroStatus	要求の状態。
OutputOntology	出力オントロジバージョン。現時点でサポートされている値は "facility-2.0" のみです。 Azure Maps Creator のオントロジの詳細については、こちらの記事を参照してください。

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	要求が正常に完了しました。

OutputOntology

出力オントロジバージョン。現時点でサポートされている値は "facility-2.0" のみです。 Azure Maps Creator のオントロジの詳細については、こちらの記事を参照してください。

名前	型	説明
facility-2.0	string	施設オントロジーでは、Azure Maps Creator を使用して施設データを Creator のデータセットに内部的に格納する方法を定義します。

Conversion - Convert

DWG パッケージを変換する

DWG パッケージの問題をデバッグする

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

メモ

Scopes

subscription-key

SAS Token

例

Convert previously uploaded DWG Package

Sample Request

Sample Response

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology

その他のリソース