Dataset - Create
を使用してデータセットを作成します。
API は Create HTTP POST 要求であり、呼び出し元は、Azure Maps Data Registry にアップロードされ、Azure Maps変換サービスを使用して変換されたデータからデータセットを作成できます。 また、アップロードされたデータが施設のオントロジ形式に準拠した GeoJSON ファイルの zip である場合は、Azure Maps Data Registry にアップロードされたデータを使用してデータセットを直接作成することもできます。 データ レジストリ サービスの詳細については、「 データ レジストリを作成する方法」を参照してください。
詳細については、「GeoJson パッケージを使用してデータセットを作成する」を参照してください。
作成要求を送信する
データセットを作成するには、必要なパラメーターを POST 使用して要求を発行します。 Create API は実行時間 の長い操作です。
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-previewPOST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={datasetId}&description={description}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
geography
|
path | True |
string |
このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。 |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
|
conversion
|
query |
string |
データセットを作成するための ID。 は |
|
|
dataset
|
query |
string |
追加するデータセットの ID。 |
|
|
description
|
query |
string |
データセットに指定する説明。 |
|
|
output
|
query |
GeoJSON ファイルを含むアップロードされた zip パッケージのオントロジ。 ただし、udid が指定されている場合、outputOntology は conversionId と相互に排他的である場合に必要です。 現時点では、値 facility-2.0 のみがサポートされています。 |
||
|
udid
|
query |
string |
データセットを作成する一意のデータ ID ( |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
[Request Accepted]\(要求を受け入れた\): 要求は処理のために受け入れ済みです。 状態を取得するには、Operation-Location ヘッダーの URL を使用してください。 Headers Operation-Location: string |
|
| Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、ユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
メモ
- このセキュリティ定義では、 ヘッダーを使用して、
x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
は Authorization URL 、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、一意の承認 URL と Azure Active Directory 構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- 現在、Azure Active Directory v1.0 または v2.0 では、職場、学校、ゲストはサポートされていますが、個人用アカウントはサポートされていません。
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
例
Create dataset from a converted CAD file provided by conversionId
Sample Request
POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0
Sample Response
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-LocationCreate dataset from a zip of GeoJSON files provided by udid
Sample Request
POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0
Sample Response
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-LocationCreate dataset with Udid and append to it a dataset created with conversionId
Sample Request
POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}
Sample Response
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-LocationCreate dataset with Udid and append to it a dataset created with udid
Sample Request
POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}
Sample Response
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location定義
| 名前 | 説明 |
|---|---|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
output |
GeoJSON ファイルを含むアップロードされた zip パッケージのオントロジ。 ただし、udid が指定されている場合、outputOntology は conversionId と相互に排他的である場合に必要です。 現時点では、値 facility-2.0 のみがサポートされています。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
error オブジェクト。 |
outputOntology
GeoJSON ファイルを含むアップロードされた zip パッケージのオントロジ。 ただし、udid が指定されている場合、outputOntology は conversionId と相互に排他的である場合に必要です。 現時点では、値 facility-2.0 のみがサポートされています。
| 名前 | 型 | 説明 |
|---|---|---|
| facility-2.0 |
string |