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

WFS - Get Features

参考

服务:: Maps Creator

API 版本:: 2.0

用于获取集合功能的详细列表。

注释

Azure Maps Creator 停用

Azure Maps Creator 室内地图服务现已弃用，将于 2025 年 9 月 30 日停用。有关详细信息，请参阅 Azure Maps Creator 生命周期结束公告。

Get Features API 是一个 HTTP GET 请求，它返回指定集合中功能的详细列表。

WFS API 遵循开放地理空间联盟 API 标准，用于功能查询数据集。

数据集由多个功能集合组成。特征集合是基于通用架构的类似类型的特征的集合。

提交获取功能请求

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0

具有可选参数:

GET https://{geography}.atlas.microsoft.com/wfs/datasets/{datasetId}/collections/{collectionId}/items?api-version=2.0&limit={limit}&bbox={bbox}&filter={filter}

URI 参数

名称	在	必需	类型	说明
collectionId	path	True	string	特定集合的标识符（名称）
datasetId	path	True	string	要从中查询的数据集的标识符。
geography	path	True	string	此参数指定 Azure Maps Creator 资源所在的位置。有效值是我们和欧盟。
api-version	query	True	string	Azure Maps API 的版本号。
bbox	query		number[]	仅选择了与提供的边界框相交的几何图形的特征。左下角，坐标轴 1 * 左下角，坐标轴 2 * 右上角，坐标轴 1 * 右上角，坐标轴 2 坐标轴 2 值坐标参考系统为 WGS84 经度/纬度（http://www.opengis.net/def/crs/OGC/1.3/CRS84），除非参数 `bbox-crs`中指定了不同的坐标引用系统。对于 WGS84 经度/纬度，值在大多数情况下是最小经度、最小纬度、最大经度和最大纬度序列。但是，如果框跨越时间线，则第一个值（最西部的框边缘）大于第三个值（最东部的框边缘）。
filter	query		string	筛选表达式以搜索给定集合中具有特定属性值的功能。仅支持标量类型和等于运算符的功能属性。这是一个特殊参数，其中参数名称是区分大小写的属性名称。此参数的方案为 {property name}={property value}。除非“filter”是集合中的属性名称之一，否则不应将“filter”用作参数名称。若要搜索“name”属性值为“21N13”的功能，请使用“name=21N13”。支持多个筛选器，应表示为多个查询参数。例如， =&= 字符串值区分大小写。
limit	query		integer minimum: 1 maximum: 500	可选限制参数限制响应文档中显示的功能数。仅计算响应文档中集合第一级的功能。不应计算显式请求的功能中包含的嵌套对象。最小值 = 1 * 最大值 = 500 * 默认值 = 10

请求头

名称	必需	类型	说明
x-ms-client-id		string	指定哪个帐户与 Microsoft Entra ID 安全模型结合使用。它表示 Azure Maps 帐户的唯一 ID，可以从 Azure Maps 管理平面帐户 API 检索。若要在 Azure Maps 中使用 Microsoft Entra ID 安全性，请参阅以下文章以获取指导。

响应

名称	类型	说明
200 OK	ExtendedGeoJsonFeatureCollection	还行
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 允许为多个用例设置基于应用程序的配置。

有关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 Maps 帐户时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用机密客户端应用程序方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

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

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

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

类型: apiKey
在: header

示例

GetFeatures

示例请求

HTTP

GET https://us.atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1&bbox=-122,47,-120,46

示例响应

状态代码:: 200

{
  "type": "FeatureCollection",
  "ontology": "Facility-2.0",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              139.6330405782921,
              35.45768668610856
            ],
            [
              139.63296283234274,
              35.45778390425868
            ],
            [
              139.63308672404617,
              35.45785022906202
            ],
            [
              139.6331451691671,
              35.45777714569986
            ],
            [
              139.6331274703629,
              35.45776767074717
            ],
            [
              139.63314677109963,
              35.45774353588138
            ],
            [
              139.6330405782921,
              35.45768668610856
            ]
          ]
        ]
      },
      "properties": {
        "originalId": "ddbbb583-4621-4e11-8859-299d1057e843",
        "categoryId": "CTG10",
        "isOpenArea": false,
        "navigableBy": [
          "pedestrian"
        ],
        "isRoutable": false,
        "routeThroughBehavior": "allowed",
        "nonPublic": false,
        "levelId": "LVL18",
        "occupants": [],
        "addressId": "DIR16",
        "addressRoomNumber": "",
        "name": "21N13",
        "nameSubtitle": "",
        "nameAlt": ""
      },
      "id": "UNIT39",
      "featureType": ""
    }
  ],
  "numberReturned": 1,
  "links": [
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1",
      "rel": "self"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0",
      "rel": "data"
    },
    {
      "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1",
      "rel": "next"
    }
  ]
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ExtendedGeoJsonFeatureCollection	使用 numberReturned 和 links 数组扩展的有效 `GeoJSON FeatureCollection` 对象类型。有关详细信息，请参阅 RFC 7946。
GeoJsonFeature	有效的 `GeoJSON Feature` 对象类型。有关详细信息，请参阅 RFC 7946。
GeoJsonGeometry	有效的 `GeoJSON` 几何图形对象。该类型必须是七种有效的 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。
GeoJsonObjectType	指定 `GeoJSON` 类型：FeatureCollection。
GeoJsonPoint	有效的 `GeoJSON Point` 几何图形类型。有关详细信息，请参阅 RFC 7946。
GeoJsonPolygon	有效的 `GeoJSON Polygon` 几何图形类型。有关详细信息，请参阅 RFC 7946。
WFSEndpointLink	指向其他 WFS 终结点的链接

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ExtendedGeoJsonFeatureCollection

Object

使用 numberReturned 和 links 数组扩展的有效 GeoJSON FeatureCollection 对象类型。有关详细信息，请参阅 RFC 7946。

名称	类型	说明
features	GeoJsonFeature[]	包含有效 `GeoJSON Feature` 对象的列表。
links	WFSEndpointLink[]	指向其他 WFS 终结点的链接。
numberReturned	integer	返回的功能数。
ontology	string	此数据集的本体版本。
type	GeoJsonObjectType	指定 `GeoJSON` 类型：FeatureCollection。

GeoJsonFeature

Object

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

名称	类型	说明
featureType	string	功能的类型。该值取决于当前功能所属的数据模型。某些数据模型可能具有空值。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有效的 `GeoJSON` 几何图形对象。该类型必须是七种有效的 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。

GeoJsonGeometry

Object

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

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

GeoJsonGeometryCollection

Object

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

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

Object

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

名称	类型	说明
coordinates	number[] (double)	`GeoJson LineString` 几何图形的坐标。
type	string: LineString	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

Object

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

名称	类型	说明
coordinates	number[] (double)	`GeoJson MultiLineString` 几何图形的坐标。
type	string: MultiLineString	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

Object

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

名称	类型	说明
coordinates	number[] (double)	`GeoJson MultiPoint` 几何图形的坐标。
type	string: MultiPoint	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

Object

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

名称	类型	说明
coordinates	number[] (double)	包含有效 `GeoJSON Polygon` 对象的列表。注意，GeoJSON 中的坐标以 x、y 顺序（经度、纬度）表示。
type	string: MultiPolygon	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonObjectType

枚举

指定 GeoJSON 类型：FeatureCollection。

值	说明
FeatureCollection	`GeoJSON FeatureCollection` 对象。

GeoJsonPoint

Object

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

名称	类型	说明
coordinates	number[] (double)	`Position` 是包含两个或多个元素的数字数组。前两个元素经度和纬度，精确按顺序排列。海拔/海拔是可选的第三个元素。有关详细信息，请参阅 RFC 7946。
type	string: Point	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

Object

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

名称	类型	说明
coordinates	number[] (double)	`GeoJson Polygon` 几何图形类型的坐标。
type	string: Polygon	指定 `GeoJSON` 类型。必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

WFSEndpointLink

Object

指向其他 WFS 终结点的链接

名称	类型	说明
href	string	链接目标。
hreflang	string	指示取消引用链接的结果的语言的提示。
rel	string	关系类型。
title	string	用于标记链接的目标，以便它可以用作人类可读标识符（例如，菜单条目），其语言由内容语言标头字段（如果存在）。
type	string	一个提示，指示取消引用链接的结果的媒体类型。

通过

WFS - Get Features

提交获取功能请求

URI 参数

请求头

响应

安全性

AADToken

备注

作用域

subscription-key

SAS Token

示例

GetFeatures

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExtendedGeoJsonFeatureCollection

GeoJsonFeature

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonObjectType

GeoJsonPoint

GeoJsonPolygon

WFSEndpointLink

其他资源