Routeset - Create

ルートセットを作成するには、 を使用します。

Create API は、呼び出し元がデータセットからルートセットを作成できるようにする HTTP POST 要求です。 ルートセットは、Azure Maps Wayfinding サービスが施設内の最短パスを検出するために使用するデータ構造です。

Create Routeset API は 、実行時間の長い操作です

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

作成要求を送信する

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

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

URI パラメーター

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

ユーザーがルートセットの説明を提供しました。

要求ヘッダー

名前 必須 説明
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 を使用してください。

ヘッダー

Operation-Location: string

Other Status Codes

ErrorResponse

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

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 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 と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

  • 現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

型: 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 a routeset from a previously created dataset

要求のサンプル

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

応答のサンプル

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

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。