Spatial - Get Buffer

參考

Service:: Maps

API Version:: 2022-08-01

用來取得 FeatureCollection ，其中每個功能都是輸入的對應索引功能周圍的緩衝區。

Get Buffer API 是 HTTP GET 要求，會傳回 FeatureCollection ，其中每個功能都是輸入對應索引功能周圍的緩衝區。根據輸入中提供的距離而定，緩衝區可能位於外部或所提供的功能內部。在FeatureCollection 輸入中，每個功能必須提供一個距離，或者如果只提供一個距離，該距離就會套用至集合中的每個Feature。幾何的正 (或負數) 緩衝區定義為Minkowski總和 (或幾何) ，其半徑等於緩衝區距離的絕對值。緩衝區 API 一律會傳回多邊形結果。線條和點的負或零距離緩衝區一律是空的多邊形。輸入功能是由使用數據登錄 API 上傳的 GeoJSON 檔案所提供，並由唯一 udid 參考。 GeoJSON 檔案可能包含 Point、MultiPoint、Polygon、MultiPolygon、LineString 和 MultiLineString 的集合。如果提供 GeometryCollection，則會忽略 GeometryCollection。

若要測試此 API，您可以從 Post Buffer API 範例上傳範例數據， (要求本文，而不使用資料登錄服務) 陣列，並將下列範例要求中的取代{udid}為udid建立數據登錄時所使用的。如需詳細資訊，請參閱如何建立數據登錄。

GET https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01&udid={udid}&distances={distances}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	JsonFormat	所需的回應格式。僅支援 `json` 格式。
geography	path	True	string	Azure 地圖服務帳戶的位置。有效值為 (美國東部、美國中西部、美國西部 2) 和歐盟 (北歐、西歐) 。在要求中提供時 `udid` ，需要此參數。例如，如果 Azure 地圖服務帳戶位於美國東部，則只會接受我們地理位置的要求。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
distances	query	True	string	每個特徵的距離清單 (一個，或所有功能) 的距離清單，以分號分隔。例如，12.34;-56.78。正距離會在特徵之外產生緩衝區，而負距離會產生特徵內的緩衝區。如果負距離大於幾何本身，則會傳回空的多邊形。
udid	query	True	string	建立數據登錄時用來上傳有效 GeoJSON FeatureCollection 物件的唯一標識符。如需詳細資訊，請參閱 RFC 7946 。所有特徵的屬性都應該包含 `geometryId`，用於識別幾何且區分大小寫。如需數據登錄服務的詳細資訊，請參閱如何建立數據登錄。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。它代表 Azure 地圖服務帳戶的唯一標識符，可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	BufferResult	確定
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

這些是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 組態。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務資源時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都會獲得存取所有 REST API 的授權。換句話說，這些目前可視為發行帳戶的主要密鑰。

對於公開的應用程式，我們建議使用可安全地儲存此密鑰之 Azure 地圖服務 REST API 的伺服器對伺服器存取。

Type: apiKey
In: header

SAS Token

這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的列出 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

Type: apiKey
In: header

範例

GetBuffer

Sample Request

HTTP

GET https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&distances=176.3

Sample Response

Status code:: 200

{
  "summary": {
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "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
              ]
            ]
          ]
        }
      }
    ]
  }
}

定義

名稱	Description
BufferResult	此物件會從成功的 Spatial Buffer 呼叫傳回。
BufferSummary
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GeoJsonFeature	有效的 `GeoJSON Feature` 物件類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonFeatureCollection	有效的 `GeoJSON FeatureCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonGeometry	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonGeometryCollection	有效的 `GeoJSON GeometryCollection` 物件類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonLineString	有效的 `GeoJSON LineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonMultiLineString	有效的 `GeoJSON MultiLineString` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonMultiPoint	有效的 `GeoJSON MultiPoint` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonMultiPolygon	有效的 `GeoJSON MultiPolygon` 物件類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonPoint	有效的 `GeoJSON Point` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
GeoJsonPolygon	有效的 `GeoJSON Polygon` 幾何類型。如需詳細資訊，請參閱 RFC 7946 。
JsonFormat	所需的回應格式。僅支援 `json` 格式。

BufferResult

此物件會從成功的 Spatial Buffer 呼叫傳回。

名稱	類型	Description
result	GeoJsonFeatureCollection	輸入緩衝區的FeatureCollection。
summary	BufferSummary

BufferSummary

名稱	類型	Description
information	string	通話期間所發生之狀況的相關信息。
udid	string	如果有的話，用戶數據的 udid

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GeoJsonFeature

有效的 GeoJSON Feature 物件類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
featureType	string	功能的類型。值取決於目前功能所屬的數據模型。某些數據模型可能會有空的值。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有效的 `GeoJSON` geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946 。
id	string	功能的標識碼。
type	string: Feature	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonFeatureCollection

有效的 GeoJSON FeatureCollection 物件類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
features	GeoJsonFeature[]	包含有效 `GeoJSON Feature` 對象的清單。
type	string: FeatureCollection	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometry

有效的 GeoJSON geometry 物件。此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
type	GeoJsonObjectType	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 物件類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	包含有效的 `GeoJSON` 幾何物件清單。請注意，GeoJSON 中的座標以 x、y 順序 (經度、緯度) 。
type	string: GeometryCollection	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	幾何座標 `GeoJson LineString` 。
type	string: LineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	幾何座標 `GeoJson MultiLineString` 。
type	string: MultiLineString	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	幾何座標 `GeoJson MultiPoint` 。
type	string: MultiPoint	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 物件類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	包含有效 `GeoJSON Polygon` 對象的清單。請注意，GeoJSON 中的座標以 x、y 順序 (經度、緯度) 。
type	string: MultiPolygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPoint

有效的 GeoJSON Point 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	`Position`是具有兩個或多個元素的數位數位數位數位。前兩個專案是經度和緯度，以該順序精確。高度/高度是選擇性的第三個專案。如需詳細資訊，請參閱 RFC 7946 。
type	string: Point	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 幾何類型。如需詳細資訊，請參閱 RFC 7946 。

名稱	類型	Description
coordinates	number[]	`GeoJson Polygon`幾何類型的座標。
type	string: Polygon	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

JsonFormat

所需的回應格式。僅支援 json 格式。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式