Spatial - Get Great Circle Distance
球のサーフェス上の 2 つのポイント間の最短距離を決定するには、 を使用します。
API は Get Great Circle Distance
、球の表面に沿って測定された、球の表面上の 2 つのポイント間の大円または最短距離を返す HTTP GET
要求です。 これは、球の内部を通る直線の計算とは異なります。 この方法は、空港間の最短距離を計算することで、飛行機の移動距離を推定するのに役立ちます。
GET https://{geography}.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query={query}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
応答の目的の形式。 サポートされているのは |
|
geography
|
path | True |
string |
Azure Maps アカウントの場所。 有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。 このパラメーターは、 が要求で指定されている場合 |
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
query
|
query | True |
string |
距離を計算する座標をコロンで区切ります。 2 つの座標が必要です。 最初の座標はソース ポイント座標、最後はターゲット ポイント座標です。 たとえば、47.622942,122.316456:57.673988,127.121513 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは OAuth 2.0 フロー Microsoft Entraです。 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 とMicrosoft Entra ID構成があります。
* Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
* Azure Maps Web SDK を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介してAzure Maps リソースを作成するときにプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスすることが許可されます。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。
一般に公開されているアプリケーションの場合、このキーを安全に格納できるAzure Maps REST API のサーバー間アクセスを使用することをお勧めします。
Type:
apiKey
In:
header
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
Type:
apiKey
In:
header
例
GetGreatCircleDistance
Sample Request
GET https://us.atlas.microsoft.com/spatial/greatCircleDistance/json?api-version=2022-08-01&query=47.622942,-122.316456:47.610378,-122.200676
Sample Response
{
"summary": {
"sourcePoint": {
"lat": 47.622942,
"lon": -122.316456
},
"targetPoint": {
"lat": 47.610378,
"lon": -122.200676
}
},
"result": {
"distanceInMeters": 8797.62
}
}
定義
名前 | 説明 |
---|---|
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Great |
このオブジェクトは、成功したグレート サークル距離呼び出しから返されます |
Great |
Summary オブジェクト |
Json |
応答の目的の形式。 サポートされているのは |
Lat |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
Result |
多角形のポイントの結果オブジェクト |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
GreatCircleDistanceResult
このオブジェクトは、成功したグレート サークル距離呼び出しから返されます
名前 | 型 | 説明 |
---|---|---|
result |
Result オブジェクト |
|
summary |
Summary オブジェクト |
GreatCircleDistanceSummary
Summary オブジェクト
名前 | 型 | 説明 |
---|---|---|
sourcePoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
|
targetPoint |
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。 |
JsonFormat
応答の目的の形式。 サポートされているのは json
形式のみです。
名前 | 型 | 説明 |
---|---|---|
json |
string |
LatLongPairAbbreviated
短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
名前 | 型 | 説明 |
---|---|---|
lat |
number |
Latitude プロパティ |
lon |
number |
Longitude プロパティ |
Result
多角形のポイントの結果オブジェクト
名前 | 型 | 説明 |
---|---|---|
intersectingGeometries |
string[] |
Geometries 配列 |
pointInPolygons |
boolean |
Point In Polygons プロパティ |