Routeset - Create

Service:

Maps Creator

API Version:

2022-09-01-preview

適用対象:価格レベルを参照してください。

Creator を使用すると、Azure Maps API と SDK を使用して、プライベート 屋内マップ データに基づいてアプリケーションを開発できます。 Azure Maps Creator の概念とツールの概要については、屋内マップの作成者に関する記事を参照してください。

この API を使用すると、呼び出し元はデータセットからルートセット データを作成できます。

ルートセット API を使用して、Azure Maps Wayfinding サービスによって使用される特殊なデータ構造を作成し、施設内の最短パスを検出します。

作成要求を送信する

ルートセットを作成するには、空の本文で POST 要求を行います。 データセットはルートセット データのソースとして使用されるため、クエリ パラメーターを datasetId 含む必要があります。

ルートセットの作成 API は 、実行時間の長い操作です。

POST https://{geography}.atlas.microsoft.com/routesets?api-version=2022-09-01-preview&datasetId={datasetId}

With optional parameters:

POST https://{geography}.atlas.microsoft.com/routesets?api-version=2022-09-01-preview&datasetId={datasetId}&description={description}

URI パラメーター

Name	In	Required	Type	Description
geography	path	True	string	このパラメーターは、Azure Maps Creator リソースの場所を指定します。 有効な値は、us と eu です。
api-version	query	True	string	Azure Maps API のバージョン番号。
datasetId	query	True	string	ルートセットの作成元となるデータセットの ID。 データセット内の施設ごとにルートセットが作成されます。
description	query		string	ユーザーがルートセットの説明を指定しました。

要求ヘッダー

Name	Required	Type	Description
x-ms-client-id		string	Azure AD セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure Mapsで Azure AD セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

Name	Type	Description
202 Accepted		[Request Accepted]\(要求を受け入れた\): 要求は処理のために受け入れ済みです。 状態を取得するには、Operation-Location ヘッダーの URL を使用してください。 Headers Operation-Location: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

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

Name	Description
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 a routeset from a previously created dataset

Sample Request

HTTP

POST https://us.atlas.microsoft.com/routesets?api-version=2022-09-01-preview&datasetId=[dataset-Id]&description=my routeset name

Sample Response

Status code:

202

Operation-Location: https://us.atlas.microsoft.com/routesets/operations/[operation-Id]?2022-09-01-preview
Access-Control-Expose-Headers: Operation-Location

定義

ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ErrorAdditionalInfo

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

Name	Type	Description
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

Name	Type	Description
error	ErrorDetail	error オブジェクト。