通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Spatial - Post Buffer

  • 参考
服务:
Maps
API 版本:
2022-08-01

使用 获取 ， FeatureCollection 其中每个特征都是输入的相应索引特征周围的缓冲区。

Post Buffer API 是一个 HTTP POST 请求，它返回 ，FeatureCollection其中每个功能都是输入的相应索引功能周围的缓冲区。 缓冲区可能位于提供的功能的外部或内部，具体取决于输入中提供的距离。 输入中 FeatureCollection 每个特征必须提供一个距离，或者如果仅提供一个距离，则该距离将应用于集合中的每个特征。 几何图形的正 (或负) 缓冲区定义为几何图形的 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) 和欧盟 (北欧、西欧) 。 在请求中提供 时 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[]

要计算缓冲区的距离列表，集合中每个特征一对一，或集合中所有特征的距离。
geometries

GeoJsonFeatureCollection

有效的 GeoJSON FeatureCollection 对象类型。 有关详细信息，请参阅 RFC 7946 。

响应

名称 类型 说明
200 OK

BufferResult

确定
Other Status Codes

ErrorResponse

发生了意外错误。

安全性

AADToken

这些是 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问控制 配对时，它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问权限。 可以通过内置角色或由 Azure Maps REST API 的一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限。

若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一种解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

  • 此安全定义 需要使用x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和Microsoft Entra ID 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。 * 使用 Azure Maps Web SDK 可以基于配置设置多个用例的应用程序。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

这是在通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面创建 Azure Maps 资源 时预配的共享密钥。

使用此密钥，任何应用程序都有权访问所有 REST API。 换句话说，这些密钥当前可以视为颁发它们的帐户的主密钥。

对于公开的应用程序，我们建议使用 Azure Maps REST API 的服务器到服务器访问权限，以便安全地存储此密钥。

类型: apiKey
在: header

SAS Token

这是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面通过 Azure Maps 资源 上的列出 SAS 操作创建的共享访问签名令牌。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，我们建议在 映射帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。

类型: apiKey
在: header

示例

PostBuffer

示例请求

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 对象。 类型必须是七种有效的 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 格式。

BufferRequestBody

具有 FeatureCollection 和距离列表的对象。 特征的所有属性都应包含 geometryId，该属性用于标识几何图形，并且区分大小写。

名称 类型 说明
distances

number[]

要计算缓冲区的距离列表，集合中每个特征一对一，或集合中所有特征的距离。
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

错误对象。

GeoJsonFeature

有效的 GeoJSON Feature 对象类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
featureType

string

功能的类型。 该值取决于当前特征所属的数据模型。 某些数据模型可能具有空值。
geometry GeoJsonGeometry:

有效的 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 。

名称 类型 说明
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 。

名称 类型 说明
type

GeoJsonObjectType

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
geometries GeoJsonGeometry[]:

包含有效 GeoJSON geometry 对象的列表。 请注意 ，GeoJSON 中的坐标采用 x、y 顺序 (经度、纬度) 。
type string:

GeometryCollection

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson LineString 坐标。
type string:

LineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiLineString 坐标。
type string:

MultiLineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

几何图形的 GeoJson MultiPoint 坐标。
type string:

MultiPoint

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
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 。

名称 类型 说明
coordinates

number[]

是 Position 包含两个或多个元素的数字数组。 前两个元素是 经度 和 纬度，精确按此顺序排列。 海拔高度 是可选的第三个元素。 有关详细信息，请参阅 RFC 7946 。
type string:

Point

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 几何类型。 有关详细信息，请参阅 RFC 7946 。

名称 类型 说明
coordinates

number[]

GeoJson Polygon几何类型的坐标。
type string:

Polygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

JsonFormat

响应的所需格式。 仅支持 json 格式。

名称 类型 说明
json

string

JavaScript 对象表示法数据交换格式