Dataset - Create
データセットの作成に使用します。
注
Azure Maps Creator の提供終了
Azure Maps Creator のフロア ガイド サービスは現在非推奨となっており、2025 年 9 月 30 日付けで提供が終了します。 詳細については、Azure Maps Creator のサポート終了のお知らせを参照してください。
Create
API は、変換された描画パッケージの conversionId
値を受け取り、新しく作成されたデータセットの datasetId
プロパティを返す HTTP POST
要求です。 詳細については、「データセット 作成する」を参照してください。
この要求は、建物用の DWG zip パッケージのアップロード、Azure Maps Conversion サービスを使用した zip パッケージの変換、変換された zip パッケージからのデータセットの作成などのシナリオで使用できます。 作成されたデータセットは、Azure Maps Tileset サービスを使用してタイルセットを作成するために使用でき、Azure Maps WFS サービスを使用してクエリを実行できます。
作成要求を送信する
データセットを作成するには、POST
要求を使用します。ここで、conversionId
クエリ パラメーターは変換された DWG zip パッケージを表す ID、datasetId
パラメーターは、現在のデータセットに追加する以前に作成されたデータセットの ID であり、必要に応じて、description
クエリ パラメーターに説明が含まれます (説明が既定の説明が指定されていない場合)。
Create API は、実行時間の長い 操作です。
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&datasetId={datasetId}&description={description}
URI パラメーター
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
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 フロー
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の 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
例
Create dataset from a converted CAD file provided by conversionId
要求のサンプル
POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]
応答のサンプル
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/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Long |
Long-Running Operations API の応答モデル。 |
Lro |
要求の状態。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
LongRunningOperationResult
Long-Running Operations API の応答モデル。
名前 | 型 | 説明 |
---|---|---|
created |
string (date-time) |
作成されたタイムスタンプ。 |
error |
エラーの詳細。 |
|
operationId |
string |
この実行時間の長い操作の ID。 |
status |
要求の状態。 |
|
warning |
エラーの詳細。 |
LroStatus
要求の状態。
値 | 説明 |
---|---|
Failed |
要求に 1 つ以上のエラーがあります。 |
NotStarted |
要求はまだ処理を開始していません。 |
Running |
要求が処理を開始しました。 |
Succeeded |
要求が正常に完了しました。 |