Conversion - Convert

リファレンス

サービス:: Maps Creator

API バージョン:: 2.0

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

手記

Azure Maps Creator の提供終了をする

Azure Maps Creator の屋内マップサービスは非推奨となり、9/30/25 に廃止されます。詳細については、「azure Maps Creatorの End of Life Announcement 」を参照してください。

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

DWG パッケージの変換

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

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

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

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

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

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

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 のバージョン番号。
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 ヘッダーを使用して結果へのパスを取得します。ヘッダー Resource-Location: string
202 Accepted		受け入れ済み要求: 要求は処理のために受け入れ済みです。状態を取得するには、Operation-Location ヘッダーの URL を使用してください。ヘッダー Operation-Location: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

名前

型

説明

200 OK

LongRunningOperationResult

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

ヘッダー

Resource-Location: string

202 Accepted

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

ヘッダー

Operation-Location: string

Other Status Codes

ErrorResponse

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

セキュリティ

AADToken

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

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

筆記

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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 で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウントを作成場合にプロビジョニングされる共有キーです。

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

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

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Convert previously uploaded DWG Package

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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"
}

状態コード:: 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

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

LongRunningOperationResult

Object

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

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

LroStatus

列挙

要求の状態。

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

OutputOntology

列挙

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

値	説明
facility-2.0	Facility ontology は、Azure Maps Creator が Creator データセットに施設データを内部的に格納する方法を定義します。

次の方法で共有

Conversion - Convert

DWG パッケージの変換

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

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

筆記

スコープ

subscription-key

SAS Token

例

Convert previously uploaded DWG Package

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

OutputOntology