Route - Post Route Range
ルート範囲 API は、指定された時間または距離の予算に基づいて、特定のしきい値内の特定の場所から到達可能な領域を示す多角形を作成します。 ポリゴン境界 (等時線) は、原点の結果である正確な多角形の中心と同様に、反時計回りの方向で返されます。
返される多角形は、空間フィルター処理に使用して、指定された等時線内で目的のフィーチャを検索できます。
国や地域ごとのルーティング利用可能性については、Azure Mapsルーティングカバレッジを参照してください。
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Azure Maps APIのバージョン番号。 |
要求ヘッダー
Media Types: "application/geo+json"
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-id |
string |
Microsoft Entra IDセキュリティモデルで使用されることを意図したアカウントを示します。 このAzure Mapsアカウントの一意IDは、Azure Maps管理プレーンのアカウントAPIから取得できます。 Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Maps |
要求本文
Media Types: "application/geo+json"
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| geometry | True |
|
|
| properties | True |
等時線ポリゴンの計算に使用するパラメーターを指定します。 |
|
| type | True |
|
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
[OK] Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
予期しないエラーが発生しました。 Media Types: "application/geo+json", "application/json" ヘッダー x-ms-error-code: string |
セキュリティ
AADToken
これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 任意のユーザー、グループ、またはサービスプリンシパルは、組み込みの役割やAzure Maps REST APIに対する1つ以上の権限で構成されたカスタムロールを通じてアクセス権を付与できます。
シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
注
- このセキュリティ定義要求アプリケーションがどのAzure Mapsリソースにアクセスを要求しているかを示すために
x-ms-client-idヘッダーを使用します。 これは、Maps 管理 APIから取得できます。 -
Authorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 - Azureロールベースのアクセス制御は、Azureポータル、PowerShell、CLI、Azure SDKs、または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 | https://atlas.microsoft.com/.default |
subscription-key
これは共有キーで、
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスすることが承認されます。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。
公開されているアプリケーションについては、このキーを安全に保存できるAzure Maps REST APIのサーバー間アクセスを利用することを推奨します。
型:
apiKey
/:
header
SAS Token
これは共有アクセス署名トークンで、
このトークンにより、どのアプリケーションもAzureの役割ベースのアクセス制御と細かい制御で、そのトークンの有効期限、速度、使用地域へのアクセスが許可されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。
パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。
型:
apiKey
/:
header
例
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
要求のサンプル
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"timeBudgetInSec": 6000
}
}
応答のサンプル
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"type": "center"
}
},
{
"type": "Feature",
"bbox": [
3.62838,
49.83259,
7.9826,
52.25674
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
5.73602,
52.03704
],
[
5.59435,
52.09456
],
[
5.42279,
52.16815
],
[
5.21276,
52.25047
],
[
5.15355,
52.21374
],
[
4.96687,
52.25674
],
[
4.739,
52.07834
],
[
4.72513,
52.05647
],
[
4.53237,
51.94553
],
[
4.31165,
51.70119
],
[
4.28917,
51.5837
],
[
3.82685,
51.48463
],
[
3.62838,
51.21096
],
[
3.89244,
50.6814
],
[
3.93493,
50.66791
],
[
3.98156,
50.49042
],
[
4.47995,
50.30944
],
[
4.60502,
50.24448
],
[
4.89999,
50.24467
],
[
5.04206,
50.08735
],
[
5.23042,
49.99214
],
[
5.40994,
49.88478
],
[
5.46178,
49.85797
],
[
5.7196,
49.86279
],
[
5.74151,
49.83259
],
[
5.9387,
50.22239
],
[
6.08535,
50.0011
],
[
6.12089,
50.04616
],
[
6.28373,
50.09472
],
[
6.51654,
49.95863
],
[
6.61034,
50.00485
],
[
6.70295,
50.00587
],
[
6.65865,
50.2947
],
[
6.79276,
50.36903
],
[
7.32163,
50.31614
],
[
7.58782,
50.36737
],
[
7.7626,
50.46919
],
[
7.9826,
50.96246
],
[
7.55924,
51.07086
],
[
7.58138,
51.36614
],
[
7.67861,
51.52015
],
[
7.35175,
51.65781
],
[
7.21664,
51.81916
],
[
7.0467,
51.9587
],
[
6.67267,
51.82713
],
[
6.48424,
51.81133
],
[
6.27316,
51.9368
],
[
6.14452,
52.01701
],
[
6.09312,
52.20847
],
[
6.01297,
52.23705
],
[
5.86605,
50.9745
],
[
5.73602,
52.03704
]
]
]
},
"properties": {
"type": "boundary"
}
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Adr |
ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。 |
|
Features |
|
|
Feature |
|
|
Input |
等時線ポリゴンの計算に使用するパラメーターを指定します。 |
|
Maps |
エラーの詳細。 |
|
Maps |
Azure Maps APIで失敗した操作のエラー詳細を返すための一般的なエラー応答。 |
|
Maps |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
Route |
到達可能な場所を決定するときにルート計算で考慮される制限を指定します。 回避では、要求で複数の値がサポートされます。 例: "avoid": ["limitedAccessHighways", "tollRoads"] |
|
Route |
ルート範囲のプロパティ。 |
|
Route |
Geometry オブジェクトとルートの追加プロパティを含む GeoJSON フィーチャ オブジェクト。 |
|
Route |
ルートの最適化に使用するパラメーターを指定します。 定義されていない場合、既定値は "fastestWithoutTraffic" であり、現在の交通情報を使用せずに移動時間を最小限に抑えるためにルートを返します。 例: "optimizeRoute":"shortest" |
|
Route |
|
|
Route |
|
|
Route |
範囲計算の開始点を指定します。 フィーチャー オブジェクトと追加のプロパティを |
|
Route |
このオブジェクトは、正常な呼び出しから返されます。 |
|
Route |
範囲ポリゴンを計算するときに考慮する移動プロファイルを指定します。 指定しない場合、既定値は "driving" です。 例: "travelMode":"driving" |
|
Route |
応答で返されるフィーチャ オブジェクトのフィーチャ タイプ。 |
|
Route |
到達可能な場所を計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。 |
|
Vehicle |
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。 |
AdrTunnelRestrictionCodeEnum
ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。
| 値 | 説明 |
|---|---|
| B |
コード B を持つ車両は、ADR トンネル カテゴリ B、C、D、E の道路から制限されます。 |
| C |
コード C を持つ車両は、ADR トンネル カテゴリ C、D、E の道路から制限されます |
| D |
コード D を持つ車両は、ADR トンネル カテゴリ D と E の道路から制限されます。 |
| E |
コード E の車両は、ADR トンネル カテゴリ E の道路から制限されます。 |
FeaturesItemTypeEnum
GeoJSON 型を指定します。 サポートされているオブジェクトの種類は Feature のみです。 詳細については、RFC 7946
| 値 | 説明 |
|---|---|
| Feature |
|
FeatureTypeEnum
GeoJSON 型を指定します。 サポートされているオブジェクトの種類は FeatureCollectionのみです。 詳細については、RFC 7946
| 値 | 説明 |
|---|---|
| FeatureCollection |
|
InputRouteRangeProperties
等時線ポリゴンの計算に使用するパラメーターを指定します。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| avoid |
到達可能な場所を決定するときにルート計算で考慮される制限を指定します。 回避では、要求で複数の値がサポートされます。 例: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
RFC 3339 セクション 5.6で定義された dateTime 値として書式設定された出発地点からの出発日時
例: "出発時": "2023-06-01T09:30:00.000-07:00" |
|
| distanceBudgetInMeters |
number (float) minimum: 0maximum: 500000 |
距離の予算は、原点のウェイポイントから移動できる最大範囲をメートル単位で指定します。
例: "distanceBudgetInMeters":5000 |
|
| isSimplifiedPolygon |
boolean |
True |
これを使用して、図形を維持しながらポリゴン頂点の数を減らす簡略化されたポリゴンが必要かどうかを指定します。 API は、既定で低定義ポリゴンを返します。 |
| optimizeRoute | fastestWithoutTraffic |
ルートの最適化に使用するパラメーターを指定します。 定義されていない場合、既定値は "fastestWithoutTraffic" であり、現在の交通情報を使用せずに移動時間を最小限に抑えるためにルートを返します。 例: "optimizeRoute":"shortest" |
|
| timeBudgetInSec |
number (float) minimum: 0maximum: 21600 |
時間の予算では、移動に使用できる最大時間 (秒) を指定し、出発地のウェイポイントからこの時間制約内に移動できる距離を定義します。
例: "timeBudgetInSec":3600 |
|
| travelMode | driving |
範囲ポリゴンを計算するときに考慮する移動プロファイルを指定します。 指定しない場合、既定値は "driving" です。 例: "travelMode":"driving" |
|
| vehicleSpec |
到達可能な場所を計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。 |
MapsErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
MapsErrorResponse
Azure Maps APIで失敗した操作のエラー詳細を返すための一般的なエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |
MapsInnerError
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラー コード。 |
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
RouteRangeAvoidEnum
到達可能な場所を決定するときにルート計算で考慮される制限を指定します。 回避では、要求で複数の値がサポートされます。
例: "avoid": ["limitedAccessHighways", "tollRoads"]
| 値 | 説明 |
|---|---|
| limitedAccessHighways |
ルート内のアクセス制限付き高速道路の使用を回避します。 |
| tollRoads |
ルート内の有料道路の使用を回避します。 |
| ferries |
ルート内でのフェリーの使用を回避します。 |
| tunnels |
ルートでのトンネルの使用を回避します。 |
| borderCrossings |
ルート内の国境を越えないようにします。 |
| lowEmissionZones |
ルート内の低排出ゾーンを回避します。 |
| unpavedRoads |
ルート内の未舗装道路を回避します。 |
| carpools |
carpool の使用を必要とするルートを回避します。 |
| carTrains |
車の列車を避けます。 |
RouteRangeFeatureProperties
ルート範囲のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| type |
応答で返されるフィーチャ オブジェクトのフィーチャ タイプ。 |
RouteRangeFeaturesItem
Geometry オブジェクトとルートの追加プロパティを含む GeoJSON フィーチャ オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| bbox |
number[] (double) |
境界ボックス オブジェクトとして定義された、地球の四角形領域。 四角形の辺は、緯度と経度の値によって定義されます。 詳細については、RFC 7946、セクション 5 例: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteRangeGeometry: |
有効な |
| properties |
ルート範囲のプロパティ。 |
|
| type |
|
RouteRangeOptimizeRouteEnum
ルートの最適化に使用するパラメーターを指定します。 定義されていない場合、既定値は "fastestWithoutTraffic" であり、現在の交通情報を使用せずに移動時間を最小限に抑えるためにルートを返します。
例: "optimizeRoute":"shortest"
| 値 | 説明 |
|---|---|
| shortest |
ルートは、距離を最小限に抑えるために計算されます。 トラフィック情報は使用されません。 |
| fastestWithoutTraffic |
トラフィック情報を考慮せずに、最速のルートを検索します。 |
| fastestWithTraffic |
ルートは、現在のトラフィック情報を使用して時間を最小限に抑えるために計算されます。
|
RouteRangePointGeometry
GeoJSON Point Geometry オブジェクトを指定します。 詳細については、RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] (double) |
|
| type |
string:
Point |
|
RouteRangePolygonGeometry
GeoJSON Polygon Geometry オブジェクトを指定します。 詳細については、RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] (double) |
|
| type |
string:
Polygon |
|
RouteRangeRequest
範囲計算の開始点を指定します。 フィーチャー オブジェクトと追加のプロパティを GeoJSON します。 詳細については、RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| geometry |
|
|
| properties |
等時線ポリゴンの計算に使用するパラメーターを指定します。 |
|
| type |
|
RouteRangeResponse
このオブジェクトは、正常な呼び出しから返されます。
| 名前 | 型 | 説明 |
|---|---|---|
| features |
Geometry オブジェクトと追加のプロパティを含むフィーチャー オブジェクトを |
|
| type |
|
RouteRangeTravelModeEnum
範囲ポリゴンを計算するときに考慮する移動プロファイルを指定します。 指定しない場合、既定値は "driving" です。
例: "travelMode":"driving"
| 値 | 説明 |
|---|---|
| driving |
車に適したルーティング プロファイルは、範囲ポリゴンの計算に使用されます。 |
| truck |
トラックなどの商用車両に適したルーティング プロファイルは、範囲ポリゴン計算に使用されます。 |
RouteRangeTypeEnum
応答で返されるフィーチャ オブジェクトのフィーチャ タイプ。
| 値 | 説明 |
|---|---|
| center |
中心点フィーチャ タイプは、範囲ポリゴン計算に使用される点を表します。 |
| boundary |
境界フィーチャ タイプは範囲ポリゴンを表します。 |
RouteRangeVehicleSpec
到達可能な場所を計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| adrTunnelRestrictionCode |
ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。 |
||
| axleCount |
integer (int64) |
車両の車軸の数。 |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。 |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。 |
| isVehicleCommercial |
boolean |
False |
車両が商用目的で使用されているかどうか。 一部の道路では、商用車両の運転が許可されない場合があります。 |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
車両の長さ (メートル単位)。 値 0 は、長さの制限が考慮されないことを意味します。 |
| loadType |
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。 |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
km/時間での車両の最高速度。 車両プロファイルの最大速度は、高速道路で車両が許可されているかどうかを確認するために使用されます。 値が 0 の場合は、車両に適した値が決定され、ルート計画中に適用されることを意味します。 ルート計画中に 0 以外の値がオーバーライドされる場合があります。 たとえば、現在のトラフィック フローは 60 km/時間です。 車両の最高速度が 50 km/時に設定されている場合、現在の状況であるため、ルーティング エンジンは 60 km/時間を考慮します。 車両の最高速度が 80 km/時間として提供されているが、現在の交通フローが 60 km/時間の場合、ルーティング エンジンは再び 60 km/時間を使用します。 |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
車両の重量 (キロ単位)。 値 0 は、重みの制限が考慮されないことを意味します。 |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。 |
VehicleLoadTypeEnum
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。
| 値 | 説明 |
|---|---|
| USHazmatClass1 |
爆発物 |
| USHazmatClass2 |
圧縮ガス |
| USHazmatClass3 |
引火性液体 |
| USHazmatClass4 |
可燃性固体 |
| USHazmatClass5 |
酸化 剤 |
| USHazmatClass6 |
毒 |
| USHazmatClass7 |
放射性 |
| USHazmatClass8 |
腐食性物質 |
| USHazmatClass9 |
Miscellaneous |
| otherHazmatExplosive |
爆発物 |
| otherHazmatGeneral |
Miscellaneous |
| otherHazmatHarmfulToWater |
水に有害 |