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

SearchGetSearchPOIOptionalParams interface

包:

azure-maps-rest

可选参数。

Extends

RequestOptionsBase

属性

brandSet	一个逗号分隔的品牌名称列表，可用于将结果限制为特定品牌。 项顺序并不重要。 当提供多个品牌时，仅返回至少) (所提供列表之一的结果。 名称中包含 “，”的品牌应放在引号中。 用法示例： brandSet=Foo brandSet=Foo，Bar brandSet=“A，B，C 逗号”，条形图
btmRight	边界框的右下位置。 例如 37.553，-122.453
connectorSet	连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序并不重要。 如果提供了多个连接器类型，则仅返回至少) (所提供列表之一的结果。 可用的连接器类型包括： StandardHouseholdCountrySpecific - 这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。 另请参阅： 插头 & 插座类型 - 世界标准。 IEC62196Type1 - IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。 IEC62196Type1CCS - IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于 IEC 62196-2 标准中定义的类型 1 连接器，另外还有两个直流 (DC) 触点，允许 DC 快速充电。 IEC62196Type2CableAttached - IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供。 IEC62196Type2Outlet - IEC 62196-2 标准中定义的类型 2 连接器。 以插座的形式提供给充电点。 IEC62196Type2CCS - IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准中所述），另外还有两个直流 (DC) 触点，允许 DC 快速充电。 IEC62196Type3 - IEC 62196-2 标准中定义的类型 3 连接器。 也被称为骗子后的原始制造商。 主要与高达 240V 单相或高达 420V 的三相基础结构结合使用。 Chademo - CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。 IEC60309AC1PhaseBlue - 工业蓝色连接器是 IEC 60309 标准中定义的连接器。 它有时被标准、颜色和单相连接器的某种组合称为 。 连接器通常具有“P+N+E，6h”配置。 IEC60309DCWhite - 工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。 Tesla - Tesla 连接器是特定于区域的 Tesla 增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时被称为特斯拉端口主要限于北美或修改的2型 (DC超过2型) 在欧洲。 用法示例： connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached
countrySet	以逗号分隔的国家/地区代码字符串，例如 FR、ES。 这会将搜索限制为指定的国家/地区
extendedPostalCodesFor	结果中应包含扩展邮政编码的索引。 可用索引包括： POI = 兴趣点 值应为 POI 或 None ，以禁用扩展邮政编码。 默认情况下，包括扩展邮政编码。 用法示例： extendedPostalCodesFor=POI extendedPostalCodesFor=None 扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性取决于区域。
language	返回搜索结果时应采用的语言。 应是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言的数据不适用于特定字段时，将使用默认语言。 有关详细信息，请参阅 支持的语言 。
lat	结果应有偏差的纬度。 例如 37.337
limit	将返回的最大响应数。 默认值：10，最小值：1，最大值：100
lon	结果应有偏差的经度。 例如 -121.89
ofs	完整结果集中返回结果的起始偏移量。 默认值：0，最小值：0，最大值：1900
openingHours	POI (兴趣点) 的营业时间。 营业时间的供应情况因可用数据而异。 可能的值包括：“nextSevenDays”
radius	结果要限制为已定义区域的半径（以米为单位）
topLeft	边界框的左上角位置。 例如 37.553，-122.453
typeahead	布尔值。 如果设置了 typeahead 标志，查询将被解释为部分输入，并且搜索将进入预测模式
view	View 参数指定通过Azure Maps服务返回哪组地缘政治争议内容，包括地图上显示的边框和标签。 View 参数 (也称为“用户区域参数”) 将显示该国家/地区的正确地图。 默认情况下，View 参数设置为“Unified”，即使尚未在请求中定义它。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例：view=IN。 有关详细信息和可用的 视图 ，请参阅支持的视图。

继承属性

abortSignal	可用于中止请求的信号。
customHeaders	{object}[customHeaders]用户定义的自定义请求标头，将在发送请求之前应用。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可以花费的毫秒数。

属性详细信息

brandSet

一个逗号分隔的品牌名称列表，可用于将结果限制为特定品牌。 项顺序并不重要。 当提供多个品牌时，仅返回至少) (所提供列表之一的结果。 名称中包含 “，”的品牌应放在引号中。 用法示例：

brandSet=Foo

brandSet=Foo，Bar

brandSet=“A，B，C 逗号”，条形图

brandSet?: string[]

属性值

string[]

btmRight

边界框的右下位置。 例如 37.553，-122.453

btmRight?: string

属性值

string

connectorSet

连接器类型的逗号分隔列表，可用于将结果限制为支持特定连接器类型的电动汽车站。 项顺序并不重要。 如果提供了多个连接器类型，则仅返回至少) (所提供列表之一的结果。 可用的连接器类型包括：

• StandardHouseholdCountrySpecific - 这些是特定区域的标准家用连接器。 它们都是交流单相以及标准电压和标准安培。 另请参阅： 插头 & 插座类型 - 世界标准。
• IEC62196Type1 - IEC 62196-2 标准中定义的类型 1 连接器。 也称为 Yazaki 后的原始制造商或 SAE J1772 标准后，首次发布它。 主要与 120V 单相或高达 240V 单相基础结构结合使用。
• IEC62196Type1CCS - IEC 62196-3 标准中定义的基于类型 1 的组合连接器。 该连接器基于 IEC 62196-2 标准中定义的类型 1 连接器，另外还有两个直流 (DC) 触点，允许 DC 快速充电。
• IEC62196Type2CableAttached - IEC 62196-2 标准中定义的类型 2 连接器。 作为连接到充电点的电缆和插头提供。
• IEC62196Type2Outlet - IEC 62196-2 标准中定义的类型 2 连接器。 以插座的形式提供给充电点。
• IEC62196Type2CCS - IEC 62196-3 标准中定义的基于类型 2 的组合连接器。 该连接器基于类型 2 连接器（如 IEC 62196-2 标准中所述），另外还有两个直流 (DC) 触点，允许 DC 快速充电。
• IEC62196Type3 - IEC 62196-2 标准中定义的类型 3 连接器。 也被称为骗子后的原始制造商。 主要与高达 240V 单相或高达 420V 的三相基础结构结合使用。
• Chademo - CHAdeMO 连接器以东京电力公司和工业合作伙伴组成的协会命名。 因此，也称为 TEPCO 的连接器。 它支持快速 DC 充电。
• IEC60309AC1PhaseBlue - 工业蓝色连接器是 IEC 60309 标准中定义的连接器。 它有时被标准、颜色和单相连接器的某种组合称为 。 连接器通常具有“P+N+E，6h”配置。
• IEC60309DCWhite - 工业白色连接器是 IEC 60309 标准中定义的 DC 连接器。
• Tesla - Tesla 连接器是特定于区域的 Tesla 增压器连接器。 也就是说，它指的是特斯拉的专有连接器，有时被称为特斯拉端口主要限于北美或修改的2型 (DC超过2型) 在欧洲。

用法示例：

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet，IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

属性值

ConnectorSet[]

countrySet

以逗号分隔的国家/地区代码字符串，例如 FR、ES。 这会将搜索限制为指定的国家/地区

countrySet?: string[]

属性值

string[]

extendedPostalCodesFor

结果中应包含扩展邮政编码的索引。 可用索引包括：

POI = 兴趣点

值应为 POI 或 None ，以禁用扩展邮政编码。

默认情况下，包括扩展邮政编码。

用法示例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=None

扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性取决于区域。

extendedPostalCodesFor?: string

属性值

string

language

返回搜索结果时应采用的语言。 应是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言的数据不适用于特定字段时，将使用默认语言。 有关详细信息，请参阅 支持的语言 。

language?: string

属性值

string

lat

结果应有偏差的纬度。 例如 37.337

lat?: number

属性值

number

limit

将返回的最大响应数。 默认值：10，最小值：1，最大值：100

limit?: number

属性值

number

lon

结果应有偏差的经度。 例如 -121.89

lon?: number

属性值

number

ofs

完整结果集中返回结果的起始偏移量。 默认值：0，最小值：0，最大值：1900

ofs?: number

属性值

number

openingHours

POI (兴趣点) 的营业时间。 营业时间的供应情况因可用数据而异。 可能的值包括：“nextSevenDays”

openingHours?: OpeningHours

属性值

OpeningHours

radius

结果要限制为已定义区域的半径（以米为单位）

radius?: number

属性值

number

topLeft

边界框的左上角位置。 例如 37.553，-122.453

topLeft?: string

属性值

string

typeahead

布尔值。 如果设置了 typeahead 标志，查询将被解释为部分输入，并且搜索将进入预测模式

typeahead?: boolean

属性值

boolean

view

View 参数指定通过Azure Maps服务返回哪组地缘政治争议内容，包括地图上显示的边框和标签。 View 参数 (也称为“用户区域参数”) 将显示该国家/地区的正确地图。 默认情况下，View 参数设置为“Unified”，即使尚未在请求中定义它。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用的法律，包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律。 示例：view=IN。 有关详细信息和可用的 视图 ，请参阅支持的视图。

view?: string

属性值

string

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 RequestOptionsBase.abortSignal

customHeaders

{object}[customHeaders]用户定义的自定义请求标头，将在发送请求之前应用。

customHeaders?: [key: string]: string

属性值

[key: string]: string

继承自 RequestOptionsBase.customHeaders

onDownloadProgress

下载进度时触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 RequestOptionsBase.onDownloadProgress

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 RequestOptionsBase.onUploadProgress

timeout

请求在自动终止之前可以花费的毫秒数。

timeout?: number

属性值

number

继承自 RequestOptionsBase.timeout