你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Search - Get Search Polygon
用于获取地理区域形状（如城市或国家/地区）的多边形数据。
API Get Polygon 是一个 HTTP GET 请求，它返回一组实体的几何数据，例如城市或国家/地区大纲，这些实体以前以 GeoJSON 格式从联机搜索请求中检索。 geometry ID 在对象中的sourceGeometry“geometry”和“id”下返回搜索 Address 或 搜索模糊调用。
从联机搜索终结点检索的几何 ID 的生存期有限，不建议将几何 ID 存储在持久存储中以供以后引用。 预期会在向提供 ID 的联机搜索方法发出请求后的几分钟内向 Polygon 方法发出请求。 该服务允许批处理请求最多 20 个标识符。
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
format
|
path | True |
Json |
响应的所需格式。 仅支持 |
|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
|
geometries
|
query | True |
string[] |
以前从联机搜索请求检索的几何图形 UUID 的逗号分隔列表。 |
请求头
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| x-ms-client-id |
string |
指定要与Microsoft Entra ID安全模型结合使用的帐户。 它表示Azure Maps帐户的唯一 ID，可从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps 中使用Microsoft Entra ID安全性，请参阅以下文章以获取指导。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
Polygon |
确定 |
| Other Status Codes |
Error |
发生了意外错误。 |
安全性
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 标识平台概述。
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 门户或使用 PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps帐户时预配的共享密钥。
使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。
对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问Azure Maps REST API，以便安全地存储密钥。
Type:
apiKey
In:
query
SAS Token
这是一个共享访问签名令牌，通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API，通过 Azure 管理平面在Azure Maps资源上列出 SAS 操作创建。
使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域 () 。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序，我们建议在 Map 帐户资源 上配置允许的来源的特定列表，以限制呈现滥用，并定期续订 SAS 令牌。
Type:
apiKey
In:
header
示例
Get the Geometry using the geometry id returned by the previous Search
Sample Request
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca
Sample Response
{
"additionalData": [
{
"providerID": "1111-2222-32-4444444444444",
"geometryData": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-122.0665062,
47.6496252
],
[
-122.0664863,
47.6496113
],
[
-122.0664843,
47.6496014
],
[
-122.0663693,
47.6495247
],
[
-122.0663017,
47.6494664
],
[
-122.0662679,
47.6494247
],
[
-122.0661647,
47.6493314
],
[
-122.067177,
47.649298
],
[
-122.090715,
47.6543598
],
[
-122.0907846,
47.6542921
],
[
-122.0908284,
47.6542603
]
]
]
},
"id": "1111-2222-32-4444444444444"
}
]
}
}
]
}定义
| 名称 | 说明 |
|---|---|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Geo |
有效的 |
|
Json |
响应的所需格式。 仅支持 |
| Polygon | |
|
Polygon |
此对象从成功的搜索多边形调用中返回 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
Error |
错误附加信息。 |
| code |
string |
错误代码。 |
| details |
Error |
错误详细信息。 |
| 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 |
Geo |
包含有效 |
| type |
string:
Feature |
指定 |
GeoJsonGeometry
有效的 GeoJSON geometry 对象。 类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| type |
Geo |
指定 |
GeoJsonGeometryCollection
有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| geometries |
GeoJsonGeometry[]:
|
包含有效 |
| type |
string:
Geometry |
指定 |
GeoJsonLineString
有效的 GeoJSON LineString 几何类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
几何图形的 |
| type |
string:
Line |
指定 |
GeoJsonMultiLineString
有效的 GeoJSON MultiLineString 几何类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
几何图形的 |
| type |
string:
Multi |
指定 |
GeoJsonMultiPoint
有效的 GeoJSON MultiPoint 几何类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
几何图形的 |
| type |
string:
Multi |
指定 |
GeoJsonMultiPolygon
有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
包含有效 |
| type |
string:
Multi |
指定 |
GeoJsonPoint
有效的 GeoJSON Point 几何类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
是 |
| type |
string:
Point |
指定 |
GeoJsonPolygon
有效的 GeoJSON Polygon 几何类型。 有关详细信息，请参阅 RFC 7946 。
| 名称 | 类型 | 说明 |
|---|---|---|
| coordinates |
number[] |
|
| type | string: |
指定 |
JsonFormat
响应的所需格式。 仅支持 json 格式。
| 名称 | 类型 | 说明 |
|---|---|---|
| json |
string |
Polygon
| 名称 | 类型 | 说明 |
|---|---|---|
| geometryData |
GeoJsonObject:
|
GeoJSON 格式的几何数据。 有关详细信息，请参阅 RFC 7946 。 仅当“error”不存在时才存在。 |
| providerID |
string |
返回实体的 ID |
PolygonResult
此对象从成功的搜索多边形调用中返回
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalData |
Polygon[] |
结果数组 |