Spatial - Post Buffer
を使用して、 FeatureCollection 各機能が入力の対応するインデックス付き機能を囲むバッファーである を取得します。
Post Buffer API は、各機能が入力のFeatureCollection対応するインデックス付き機能を囲むバッファーである を返す HTTP POST 要求です。 バッファーは、入力に指定された距離に応じて、指定された機能の外側または内部にある可能性があります。 入力にフィーチャー FeatureCollection ごとに 1 つの距離を指定するか、距離が 1 つだけ指定されている場合は、その距離がコレクション内のすべてのフィーチャに適用されます。 ジオメトリの正 (または負) バッファーは、バッファー距離の絶対値と等しい半径の円を持つジオメトリの Minkowski 合計 (または差) として定義されます。 バッファー API は常に多角形の結果を返します。 線と点の負またはゼロ距離バッファーは、常に空の多角形です。 入力には、Point、MultiPoint、Polygon、MultiPolygon、LineString、MultiLineString のコレクションが含まれる場合があります。 指定した場合、GeometryCollection は無視されます。
POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
format
|
path | True |
応答の目的の形式。 サポートされているのは |
|
|
geography
|
path | True |
string |
Azure Maps アカウントの場所。 有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。 このパラメーターは、 が要求で指定されている場合 |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| distances |
number[] |
バッファーを計算する距離の一覧、コレクション内のフィーチャーごとに 1 対 1、またはコレクション内のすべてのフィーチャーに対して 1 つ。 |
| geometries |
有効な |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 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
例
PostBuffer
Sample Request
POST https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01
{
"geometries": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": "ExampleId"
},
"geometry": {
"type": "Point",
"coordinates": [
-111.9267386,
33.5362475
]
}
}
]
},
"distances": [
176.3
]
}
Sample Response
{
"summary": {
"udid": null,
"information": "1 feature processed in user data"
},
"result": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"geometryId": "ExampleId",
"bufferDist": 176.3
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-111.92483859605078,
33.5362475
],
[
-111.92487510409389,
33.53587682761772
],
[
-111.92498322523961,
33.535520399967204
],
[
-111.92515880445296,
33.535191914363196
],
[
-111.92539509432322,
33.53490399432323
],
[
-111.92568301436319,
33.53466770445297
],
[
-111.9260114999672,
33.53449212523963
],
[
-111.9263679276177,
33.5343840040939
],
[
-111.9267386,
33.534347496050785
],
[
-111.92710927238228,
33.5343840040939
],
[
-111.92746570003278,
33.53449212523963
],
[
-111.9277941856368,
33.53466770445297
],
[
-111.92808210567676,
33.53490399432323
],
[
-111.92831839554702,
33.535191914363196
],
[
-111.92849397476037,
33.535520399967204
],
[
-111.9286020959061,
33.53587682761772
],
[
-111.92863860394921,
33.5362475
],
[
-111.9286020959061,
33.53661817238228
],
[
-111.92849397476037,
33.5369746000328
],
[
-111.92831839554702,
33.53730308563681
],
[
-111.92808210567676,
33.537591005676774
],
[
-111.9277941856368,
33.53782729554703
],
[
-111.92746570003278,
33.53800287476037
],
[
-111.92710927238228,
33.5381109959061
],
[
-111.9267386,
33.53814750394922
],
[
-111.9263679276177,
33.5381109959061
],
[
-111.9260114999672,
33.53800287476037
],
[
-111.92568301436319,
33.53782729554703
],
[
-111.92539509432322,
33.537591005676774
],
[
-111.92515880445296,
33.53730308563681
],
[
-111.92498322523961,
33.5369746000328
],
[
-111.92487510409389,
33.53661817238228
],
[
-111.92483859605078,
33.5362475
]
]
]
}
}
]
}
}定義
| 名前 | 説明 |
|---|---|
|
Buffer |
FeatureCollection と距離の一覧を持つオブジェクト。 フィーチャのすべてのプロパティに を含める |
|
Buffer |
このオブジェクトは、成功した空間バッファー呼び出しから返されます。 |
|
Buffer |
|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Geo |
有効な |
|
Json |
応答の目的の形式。 サポートされているのは |
BufferRequestBody
FeatureCollection と距離の一覧を持つオブジェクト。 フィーチャのすべてのプロパティに を含める geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
| 名前 | 型 | 説明 |
|---|---|---|
| distances |
number[] |
バッファーを計算する距離の一覧、コレクション内のフィーチャーごとに 1 対 1、またはコレクション内のすべてのフィーチャーに対して 1 つ。 |
| geometries |
有効な |
BufferResult
このオブジェクトは、成功した空間バッファー呼び出しから返されます。
| 名前 | 型 | 説明 |
|---|---|---|
| result |
入力のバッファーの FeatureCollection。 |
|
| summary |
BufferSummary
| 名前 | 型 | 説明 |
|---|---|---|
| information |
string |
通話中に発生した内容に関する情報。 |
| udid |
string |
ユーザー データが存在する場合の udid |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細です。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
error オブジェクト。 |
GeoJsonFeature
有効な GeoJSON Feature オブジェクト型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| featureType |
string |
機能の種類です。 この値は、現在の特徴が含まれるデータ モデルによって異なります。 一部のデータ モデルには空の値が含まれる場合があります。 |
| geometry | GeoJsonGeometry: |
有効な |
| id |
string |
機能の識別子。 |
| type |
string:
Feature |
型を指定します |
GeoJsonFeatureCollection
有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| features |
有効な |
|
| type |
string:
Feature |
型を指定します |
GeoJsonGeometry
有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| type |
Geo |
型を指定します |
GeoJsonGeometryCollection
有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| geometries | GeoJsonGeometry[]: |
有効な |
| type |
string:
Geometry |
型を指定します |
GeoJsonLineString
有効な GeoJSON LineString geometry 型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
ジオメトリの |
| type |
string:
Line |
型を指定します |
GeoJsonMultiLineString
有効な GeoJSON MultiLineString geometry 型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
ジオメトリの |
| type |
string:
Multi |
型を指定します |
GeoJsonMultiPoint
有効な GeoJSON MultiPoint geometry 型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
ジオメトリの |
| type |
string:
Multi |
型を指定します |
GeoJsonMultiPolygon
有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
有効な |
| type |
string:
Multi |
型を指定します |
GeoJsonPoint
有効な GeoJSON Point geometry 型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
は |
| type |
string:
Point |
型を指定します |
GeoJsonPolygon
有効な GeoJSON Polygon geometry 型。 詳細については、 RFC 7946 を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| coordinates |
number[] |
ジオメトリタイプの |
| type |
string:
Polygon |
型を指定します |
JsonFormat
応答の目的の形式。 サポートされているのは json 形式のみです。
| 名前 | 型 | 説明 |
|---|---|---|
| json |
string |