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

Search - Get Polygon

使用 获取地理区域形状(如城市或国家/地区)的多边形数据。

API Get Polygon 是一个 HTTP GET 请求,它提供地理区域轮廓的多边形数据,例如城市或国家/地区。

GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}

URI 参数

名称 必需 类型 说明
api-version
query True

string

Azure Maps API 的版本号。

coordinates
query True

number[]

地球上指定为经度和纬度的点。 示例:&坐标=lon,lat

resolution
query

ResolutionEnum

分辨率确定要发送回的点数。 如果未指定,则默认值为中等分辨率。

resultType
query

BoundaryResultTypeEnum

为其返回边界的地缘政治概念。 如果未指定,则默认值为 countryRegion 结果类型。

view
query

string

表示 ISO 3166-1 Alpha-2 区域/国家/地区代码的字符串。 这将更改地缘政治争议边界和标签,使其与指定的用户区域保持一致。 默认情况下,View 参数设置为“Auto”,即使你尚未在请求中定义它。

有关详细信息,请参阅 支持的视图 ,并查看可用的视图。

请求头

名称 必需 类型 说明
x-ms-client-id

string

指定要与 Azure AD 安全模型一起使用的帐户。 它表示 Azure Maps 帐户的唯一 ID,可以从 Azure Maps 管理平面帐户 API 检索。 若要在 Azure Maps 中使用 Azure AD 安全性,请参阅以下 文章 以获取指导。

Accept-Language

string

应返回搜索结果的语言。

有关详细信息,请参阅 支持的语言

响应

名称 类型 说明
200 OK

Boundary

确定

Media Types: "application/geo+json"

Other Status Codes

ErrorResponse

发生了意外错误。

Media Types: "application/geo+json"

安全性

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 可以基于配置设置多个用例的应用程序。
  • 有关Microsoft标识平台的详细信息,请参阅 Microsoft标识平台概述

类型: 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

示例

Get polygon for a city at coordinates -122.204141,47.612560

示例请求

GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small

示例响应

Content-Type: application/geo+json
{
  "type": "Feature",
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.13035,
              47.53502
            ],
            [
              -122.12882,
              47.53567
            ],
            [
              -122.12638000000001,
              47.535140000000006
            ],
            [
              -122.12378000000001,
              47.53717
            ],
            [
              -122.12068000000001,
              47.537620000000004
            ],
            [
              -122.12028000000001,
              47.538000000000004
            ],
            [
              -122.11682,
              47.537940000000006
            ],
            [
              -122.11527000000001,
              47.53609
            ],
            [
              -122.11119000000001,
              47.536080000000005
            ],
            [
              -122.11103000000001,
              47.539280000000005
            ],
            [
              -122.10832,
              47.539530000000006
            ],
            [
              -122.10830000000001,
              47.54057
            ],
            [
              -122.11006,
              47.54055
            ],
            [
              -122.10999000000001,
              47.542640000000006
            ],
            [
              -122.11185,
              47.54298000000001
            ],
            [
              -122.11183000000001,
              47.54426
            ],
            [
              -122.1114,
              47.543800000000005
            ],
            [
              -122.10936000000001,
              47.54379
            ],
            [
              -122.10912,
              47.54462
            ],
            [
              -122.10745000000001,
              47.544830000000005
            ],
            [
              -122.10808000000002,
              47.545190000000005
            ],
            [
              -122.10808000000002,
              47.54656000000001
            ],
            [
              -122.10665000000002,
              47.546580000000006
            ],
            [
              -122.10711,
              47.544700000000006
            ],
            [
              -122.10530000000001,
              47.54473
            ],
            [
              -122.1054,
              47.546910000000004
            ],
            [
              -122.10434000000001,
              47.54693
            ],
            [
              -122.10433,
              47.544830000000005
            ],
            [
              -122.10056000000002,
              47.544940000000004
            ],
            [
              -122.1007,
              47.548500000000004
            ],
            [
              -122.10194000000001,
              47.54849
            ],
            [
              -122.10194000000001,
              47.54883
            ],
            [
              -122.10194000000001,
              47.549510000000005
            ],
            [
              -122.10071,
              47.54883
            ],
            [
              -122.10048,
              47.54849
            ],
            [
              -122.10047000000002,
              47.54883
            ],
            [
              -122.10038000000002,
              47.55904
            ],
            [
              -122.09796000000001,
              47.55923000000001
            ],
            [
              -122.09870000000001,
              47.560570000000006
            ],
            [
              -122.09818000000001,
              47.56248
            ],
            [
              -122.10011000000002,
              47.56839
            ],
            [
              -122.09876000000001,
              47.56884
            ],
            [
              -122.09942000000001,
              47.569900000000004
            ],
            [
              -122.09782000000001,
              47.56983
            ],
            [
              -122.09672,
              47.58019
            ],
            [
              -122.09885000000001,
              47.58666
            ],
            [
              -122.09796000000001,
              47.59503
            ],
            [
              -122.09664000000001,
              47.602230000000006
            ],
            [
              -122.09411000000001,
              47.607240000000004
            ],
            [
              -122.09104,
              47.610240000000005
            ],
            [
              -122.08366000000001,
              47.615660000000005
            ],
            [
              -122.08008000000001,
              47.61939
            ],
            [
              -122.07904,
              47.62201
            ],
            [
              -122.07959000000001,
              47.627520000000004
            ],
            [
              -122.08008000000001,
              47.627520000000004
            ],
            [
              -122.09181000000001,
              47.627520000000004
            ],
            [
              -122.09221000000001,
              47.62717000000001
            ],
            [
              -122.09256,
              47.627520000000004
            ],
            [
              -122.11094000000001,
              47.62765
            ],
            [
              -122.11091,
              47.636720000000004
            ],
            [
              -122.11091,
              47.64609
            ],
            [
              -122.11431,
              47.646060000000006
            ],
            [
              -122.11437000000001,
              47.64533
            ],
            [
              -122.11597,
              47.64374
            ],
            [
              -122.12254000000001,
              47.638510000000004
            ],
            [
              -122.12542,
              47.636720000000004
            ],
            [
              -122.12809000000001,
              47.635200000000005
            ],
            [
              -122.13241000000001,
              47.63515
            ],
            [
              -122.13234000000001,
              47.63268
            ],
            [
              -122.13407000000001,
              47.63156000000001
            ],
            [
              -122.13484000000001,
              47.62935
            ],
            [
              -122.13626000000001,
              47.62820000000001
            ],
            [
              -122.1372,
              47.627860000000005
            ],
            [
              -122.14184000000002,
              47.62787
            ],
            [
              -122.14321000000001,
              47.62713
            ],
            [
              -122.14312000000001,
              47.636720000000004
            ],
            [
              -122.14335000000001,
              47.660590000000006
            ],
            [
              -122.1641,
              47.66077000000001
            ],
            [
              -122.16453000000001,
              47.646370000000005
            ],
            [
              -122.16797000000001,
              47.64621
            ],
            [
              -122.19629,
              47.64643
            ],
            [
              -122.19629,
              47.64289
            ],
            [
              -122.19846000000001,
              47.642860000000006
            ],
            [
              -122.19846000000001,
              47.64242
            ],
            [
              -122.19982000000002,
              47.6424
            ],
            [
              -122.20169000000001,
              47.644600000000004
            ],
            [
              -122.20341,
              47.643190000000004
            ],
            [
              -122.20818000000001,
              47.6435
            ],
            [
              -122.21014000000001,
              47.643130000000006
            ],
            [
              -122.20962000000002,
              47.642920000000004
            ],
            [
              -122.20974000000001,
              47.636720000000004
            ],
            [
              -122.21005000000001,
              47.62107
            ],
            [
              -122.22268000000001,
              47.62106000000001
            ],
            [
              -122.22268000000001,
              47.62066
            ],
            [
              -122.22203,
              47.620470000000005
            ],
            [
              -122.22282000000001,
              47.619890000000005
            ],
            [
              -122.22142000000001,
              47.618570000000005
            ],
            [
              -122.22248,
              47.61838
            ],
            [
              -122.22271,
              47.617200000000004
            ],
            [
              -122.22136,
              47.617180000000005
            ],
            [
              -122.21985000000001,
              47.61643
            ],
            [
              -122.22044000000001,
              47.614470000000004
            ],
            [
              -122.22033,
              47.603840000000005
            ],
            [
              -122.22043000000001,
              47.59682
            ],
            [
              -122.21702,
              47.59038
            ],
            [
              -122.21653,
              47.59042
            ],
            [
              -122.21572,
              47.588240000000006
            ],
            [
              -122.21067000000001,
              47.58375
            ],
            [
              -122.20153,
              47.57887
            ],
            [
              -122.20227000000001,
              47.57864000000001
            ],
            [
              -122.20132000000001,
              47.578770000000006
            ],
            [
              -122.20034000000001,
              47.57822
            ],
            [
              -122.19901000000002,
              47.57592
            ],
            [
              -122.19923000000001,
              47.567460000000004
            ],
            [
              -122.20034000000001,
              47.55962
            ],
            [
              -122.20072,
              47.55966
            ],
            [
              -122.20114000000001,
              47.557520000000004
            ],
            [
              -122.20119000000001,
              47.54943
            ],
            [
              -122.20160000000001,
              47.549440000000004
            ],
            [
              -122.20167000000001,
              47.54883
            ],
            [
              -122.20200000000001,
              47.54609000000001
            ],
            [
              -122.19676000000001,
              47.54621
            ],
            [
              -122.19545000000001,
              47.54609000000001
            ],
            [
              -122.19545000000001,
              47.545750000000005
            ],
            [
              -122.19091000000002,
              47.54580000000001
            ],
            [
              -122.1907,
              47.54216
            ],
            [
              -122.18581,
              47.542100000000005
            ],
            [
              -122.18116,
              47.541140000000006
            ],
            [
              -122.17142000000001,
              47.54086
            ],
            [
              -122.16987,
              47.54008
            ],
            [
              -122.16797000000001,
              47.540060000000004
            ],
            [
              -122.16554000000001,
              47.54005
            ],
            [
              -122.16439000000001,
              47.54281
            ],
            [
              -122.16433,
              47.545480000000005
            ],
            [
              -122.15356000000001,
              47.54538
            ],
            [
              -122.15359000000001,
              47.541760000000004
            ],
            [
              -122.14280000000001,
              47.541520000000006
            ],
            [
              -122.14288,
              47.539370000000005
            ],
            [
              -122.13645000000001,
              47.53826
            ],
            [
              -122.13035,
              47.53502
            ]
          ],
          [
            [
              -122.19957000000001,
              47.58372000000001
            ],
            [
              -122.20448,
              47.583830000000006
            ],
            [
              -122.20585000000001,
              47.586780000000005
            ],
            [
              -122.19654000000001,
              47.586740000000006
            ],
            [
              -122.19655000000002,
              47.58379
            ],
            [
              -122.19957000000001,
              47.58372000000001
            ]
          ]
        ]
      }
    ]
  },
  "properties": {
    "name": "Bellevue",
    "copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
    "copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
    "geometriesCopyright": [
      {
        "sourceName": "TOM",
        "copyright": "TomTom"
      }
    ]
  }
}

定义

名称 说明
Boundary

GeoJSON GeocodingFeature 描述地理区域边界的 对象。 使用 描述 GeoJSON GeometryCollection特征的几何图形。

请注意,该服务通常返回包含 Polygon 或 MultiPolygon 子类型的 GeometryCollection。

BoundaryResultTypeEnum

要为其返回边界的地缘政治概念。 如果未指定,则默认值为 countryRegion 结果类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

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

GeometryCopyright

边界对象的几何图形的版权信息。

ResolutionEnum

分辨率确定要发回的点数。 如果未指定,则默认值为中等分辨率。

Boundary

GeoJSON GeocodingFeature 描述地理区域边界的 对象。 使用 描述 GeoJSON GeometryCollection特征的几何图形。

请注意,该服务通常返回包含 Polygon 或 MultiPolygon 子类型的 GeometryCollection。

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946

copyright

string

版权字符串。

copyrightURL

string

列出 Azure Maps 的许多数据提供程序及其相关版权信息的 URL。

featureType

string

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

geometriesCopyright

GeometryCopyright[]

边界对象的每个几何图形的版权信息的集合,其出现顺序相同。

geometry GeoJsonGeometry:

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息,请参阅 RFC 7946

id

string

功能的标识符。

name

string

与地理区域关联的名称。

type string:

Feature

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

BoundaryResultTypeEnum

要为其返回边界的地缘政治概念。 如果未指定,则默认值为 countryRegion 结果类型。

名称 类型 说明
adminDistrict

string

国家/地区级别的第一个行政级别,例如州或省。

adminDistrict2

string

国家/地区级别的第二个行政级别,例如县。

countryRegion

string

国家或地区。

locality

string

人居的集中区域,如城市、城镇或村庄。

neighborhood

string

填充位置的一部分,通常是众所周知的,但通常具有模糊的边界。

postalCode

string

最小的邮政编码类别,例如邮政编码。

postalCode2

string

通过聚合 postalCode 区域创建的 postalCode 之后的下一个最大的邮政编码类别。

postalCode3

string

通过聚合 postalCode2 区域创建的 postalCode2 之后的下一个最大的邮政编码类别。

postalCode4

string

通过聚合 postalCode3 区域创建的 postalCode3 之后的下一个最大的邮政编码类别。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeoJsonGeometry

有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息,请参阅 RFC 7946

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946

type

GeoJsonObjectType

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

GeoJsonGeometryCollection

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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 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

名称 类型 说明
bbox

number[]

边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946

coordinates

number[]

GeoJson Polygon几何类型的坐标。

type string:

Polygon

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

GeometryCopyright

边界对象的几何图形的版权信息。

名称 类型 说明
copyright

string

数据提供程序的版权字符串

sourceName

string

数据提供程序的名称

ResolutionEnum

分辨率确定要发回的点数。 如果未指定,则默认值为中等分辨率。

名称 类型 说明
huge

string

返回具有更多点或相同点数的边界几何图形。

large

string

返回具有更多点或与中等点数相同的边界几何图形。

medium

string

返回具有更多点或相同点数的小点的边界几何图形。

small

string

返回点最少的边界几何图形。