Route - Get Route Operations Result
非同期操作の結果を操作 ID で取得します。
GET {endpoint}/route/operations/{id}/result?api-version=2025-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Mapsサービスのホストネーム。 Azureパブリッククラウドには |
|
id
|
path | True |
string minLength: 36maxLength: 36 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
非同期操作の実行依頼後にシステムが生成した一意の識別子。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-id |
string |
Microsoft Entra IDセキュリティモデルで使用されることを意図したアカウントを示します。 このAzure Mapsアカウントの一意IDは、Azure Maps管理プレーンのアカウントAPIから取得できます。
Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Maps |
|
| Accept-Language |
string |
ルーティング結果を返す言語。 詳細については、Azure Mapsの |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK | RouteOperationResponse: |
要求は成功しました。 |
| 404 Not Found |
サーバーは、要求されたリソースを見つけることができません。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
AadToken
これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
Note
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している 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 |
subscription-key
これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
header
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
Retrieve the async matrix result
要求のサンプル
GET https://atlas.microsoft.com/route/operations/bc3f9365-3ee0-4564-aa27-825016325557/result?api-version=2025-01-01
応答のサンプル
{
"type": "Feature",
"geometry": null,
"kind": "RouteMatrix",
"properties": {
"matrix": [
{
"arrivalAt": "2022-12-20T00:21:14+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 573064,
"durationInSeconds": 27677,
"durationTrafficInSeconds": 27677,
"originIndex": 0,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 0,
"statusCode": 400
},
{
"arrivalAt": "2022-12-19T22:19:10+01:00",
"departureAt": "2022-12-19T16:39:57+01:00",
"destinationIndex": 0,
"distanceInMeters": 452488,
"durationInSeconds": 20353,
"durationTrafficInSeconds": 20353,
"originIndex": 1,
"statusCode": 200
},
{
"destinationIndex": 1,
"error": {
"code": "OUT_OF_REGION",
"message": "Input coordinates out of region"
},
"originIndex": 1,
"statusCode": 400
}
],
"summary": {
"successfulCount": 2,
"totalCount": 4
}
}
}
{
"error": {
"code": "NotFound",
"message": "Not Found: the requested resource could not be found."
}
}
定義
| 名前 | 説明 |
|---|---|
|
Common |
エラーの詳細。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Features |
|
|
Maps |
エラーの詳細。 |
|
Maps |
Azure Maps APIで失敗した操作のエラー詳細を返すための一般的なエラー応答。 |
|
Maps |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
Route |
ルート Leg の各操縦ポイントの運転指示と追加のプロパティを指定します。 |
|
Route |
ルート マトリックスのプロパティ。 |
|
Route |
ルート マトリックス項目の結果 |
|
Route |
ルート マトリックス要求の概要 |
|
Route |
非同期操作の種類 |
CommonErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
FeaturesItemTypeEnum
GeoJSON 型を指定します。 サポートされているオブジェクトの種類は Feature のみです。 詳細については、RFC 7946
| 値 | 説明 |
|---|---|
| Feature |
|
MapsErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
MapsErrorResponse
Azure Maps APIで失敗した操作のエラー詳細を返すための一般的なエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |
MapsInnerError
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
RouteMatrixAsyncResponse
ルート Leg の各操縦ポイントの運転指示と追加のプロパティを指定します。
| 名前 | 型 | 説明 |
|---|---|---|
| geometry |
geometry オブジェクトが null です |
|
| kind |
string:
Route |
非同期操作の種類 |
| properties |
ルート マトリックスのプロパティ。 |
|
| type |
|
RouteMatrixFeatureProperties
ルート マトリックスのプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| matrix |
ルート結果のマトリックス。 |
|
| summary |
ルート マトリックス要求の概要 |
RouteMatrixItemResult
ルート マトリックス項目の結果
| 名前 | 型 | 説明 |
|---|---|---|
| arrivalAt |
string (date-time) |
トラフィックの状態を考慮した推定到着時間は、RFC 3339 セクション 5.6 |
| departureAt |
string (date-time) |
交通状況を考慮した推定出発時間は、RFC 3339 セクション 5.6 |
| destinationIndex |
integer (int32) |
変換先ポイントのインデックス |
| distanceInMeters |
number (double) |
Length In Meters プロパティ |
| durationInSeconds |
integer (int64) |
交通状況によるルートの遅延を含まない推定移動時間 (秒単位)。 |
| durationTrafficInSeconds |
integer (int64) |
現在の交通状況に対応する |
| error |
エラーの詳細。 |
|
| originIndex |
integer (int32) |
原点のインデックス |
| statusCode |
integer (int32) |
現在のセルの HTTP 状態コード。 |
RouteMatrixSummary
ルート マトリックス要求の概要
| 名前 | 型 | 説明 |
|---|---|---|
| successfulCount |
integer (int32) |
このマトリックス内の成功したルートの数。 |
| totalCount |
integer (int32) |
このマトリックス内のルートの合計数。 |
RouteOperationKindEnum
非同期操作の種類
| 値 | 説明 |
|---|---|
| RouteMatrix |
ルート マトリックス非同期ジョブ。 |