Spatial - Post Buffer

リファレンス

サービス:: Maps

API バージョン:: 2022-08-01

を使用して、 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-01

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
geography	path	True	string	Azure Maps アカウントの場所。有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。このパラメーターは、が要求で指定されている場合 `udid` に必要です。たとえば、Azure Maps アカウントが米国東部にある場合、地理への要求のみが受け入れられます。
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	GeoJsonFeatureCollection	有効な `GeoJSON FeatureCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。

応答

名前	型	説明
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 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 プラットフォームの概要」を参照してください。

型: 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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソースを作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。つまり、これらは現在、発行先のアカウントのマスターキーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンを介して Azure Maps リソースの SAS の一覧表示操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

PostBuffer

要求のサンプル

HTTP

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
  ]
}

応答のサンプル

状態コード:: 200

{
  "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
              ]
            ]
          ]
        }
      }
    ]
  }
}

定義

名前	説明
BufferRequestBody	FeatureCollection と距離のリストを持つオブジェクト。フィーチャのすべてのプロパティには、が含まれている `geometryId`必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。
BufferResult	このオブジェクトは、成功した空間バッファー呼び出しから返されます。
BufferSummary
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeoJsonFeature	有効な `GeoJSON Feature` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonFeatureCollection	有効な `GeoJSON FeatureCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonGeometry	有効な `GeoJSON` geometry オブジェクト。この型は、有効な 7 つの GeoJSON ジオメトリ型 (Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection) のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。
GeoJsonGeometryCollection	有効な `GeoJSON GeometryCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiLineString	有効な `GeoJSON MultiLineString` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPolygon	有効な `GeoJSON MultiPolygon` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonPolygon	有効な `GeoJSON Polygon` geometry 型。詳細については、 RFC 7946 を参照してください。
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。

BufferRequestBody

FeatureCollection と距離のリストを持つオブジェクト。フィーチャのすべてのプロパティには、が含まれている geometryId必要があります。これはジオメトリを識別するために使用され、大文字と小文字が区別されます。

名前	型	説明
distances	number[]	バッファーを計算する距離の一覧、コレクション内のフィーチャーごとに 1 対 1、またはコレクション内のすべてのフィーチャーに対して 1 つ。
geometries	GeoJsonFeatureCollection	有効な `GeoJSON FeatureCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。

BufferResult

このオブジェクトは、成功した空間バッファー呼び出しから返されます。

名前	型	説明
result	GeoJsonFeatureCollection	入力のバッファーの FeatureCollection。
summary	BufferSummary

BufferSummary

名前	型	説明
information	string	呼び出し中に発生した内容に関する情報。
udid	string	ユーザーデータが存在する場合の udid

ErrorAdditionalInfo

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

GeoJsonFeature

有効な GeoJSON Feature オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
featureType	string	機能の種類です。値は、現在の特徴が含まれるデータモデルによって異なります。一部のデータモデルには空の値が含まれる場合があります。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有効な `GeoJSON` geometry オブジェクト。この型は、有効な 7 つの GeoJSON ジオメトリ型 (Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection) のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。
id	string	機能の識別子。
type	string: Feature	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonFeatureCollection

有効な GeoJSON FeatureCollection オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
features	GeoJsonFeature[]	有効な `GeoJSON Feature` オブジェクトの一覧を格納します。
type	string: FeatureCollection	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。この型は、有効な 7 つの GeoJSON ジオメトリ型 (Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection) のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。

名前	型	説明
type	GeoJsonObjectType	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	有効な `GeoJSON` geometry オブジェクトの一覧が含まれます。 GeoJSON の座標は x、y 順 (経度、緯度) であることに注意してください。
type	string: GeometryCollection	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonLineString

有効な GeoJSON LineString geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson LineString` 座標。
type	string: LineString	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiLineString

有効な GeoJSON MultiLineString geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson MultiLineString` 座標。
type	string: MultiLineString	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiPoint

有効な GeoJSON MultiPoint geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson MultiPoint` 座標。
type	string: MultiPoint	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	有効な `GeoJSON Polygon` オブジェクトの一覧を格納します。 GeoJSON の座標は x、y 順 (経度、緯度) であることに注意してください。
type	string: MultiPolygon	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonPoint

有効な GeoJSON Point geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	は `Position` 、2 つ以上の要素を持つ数値の配列です。最初の 2 つの要素は経度と緯度であり、正確にはその順序です。高度/標高は、オプションの 3 番目の要素です。詳細については、 RFC 7946 を参照してください。
type	string: Point	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonPolygon

有効な GeoJSON Polygon geometry 型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	geometry 型の `GeoJson Polygon` 座標。
type	string: Polygon	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

次の方法で共有