次の方法で共有


Dataset - Create

を使用してデータセットを作成します。

Create API は、変換された描画パッケージの値をconversionId受け取り、新しく作成されたデータセットの プロパティをdatasetId返す HTTP POST 要求です。 詳細については、「 データセットを作成する」を参照してください。

この要求は、建物の DWG zip パッケージのアップロード、Azure Maps Conversion サービスを使用した zip パッケージの変換、変換された zip パッケージからのデータセットの作成などのシナリオで使用できます。 作成されたデータセットは、Azure Maps Tileset サービスを使用してタイルセットを作成するために使用でき、Azure Maps WFS サービスを介してクエリを実行できます。

作成要求を送信する

データセットを作成するには、クエリ パラメーターがconversionId変換された DWG zip パッケージを表す ID である要求を使用POSTします。パラメーターは、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 パラメーター

名前 / 必須 説明
geography
path True

string

このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。

api-version
query True

string

Azure Maps API のバージョン番号。

conversionId
query True

string

データセットの作成に使用される一意の ID。 は conversionId 、Conversion サービス Convert API の正常な呼び出しから取得されている必要があり、同じ名前の複数のクエリ パラメーターを指定できます (複数指定されている場合)。

datasetId
query

string

追加するデータセットの ID。 データセットは、datasetId と一致する以前のデータセット作成呼び出しから生成される必要があります

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

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

ヘッダー

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 を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

型: 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

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

定義

名前 説明
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

要求が正常に完了しました。