通过

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

@azure-rest/maps-search package

  • 参考

接口

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

结果的地址
BoundaryOutput

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

请注意，该服务通常返回包含多边形或 MultiPolygon 子类型的 GeometryCollection。
BoundaryPropertiesOutput

边界对象的属性。
ErrorAdditionalInfoOutput

资源管理错误附加信息。
ErrorDetailOutput

错误详细信息。
ErrorResponseOutput

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

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

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

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

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

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

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

由 GeoJson MultiPoint包含的数据。
GeoJsonMultiPointOutput

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

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

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

由 GeoJson Point包含的数据。
GeoJsonPointOutput

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

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

要处理的地址地理编码查询/请求的列表。 该列表最多可以包含 100 个查询，并且必须至少包含 1 个查询。
GeocodingBatchRequestItem

Batch Query 对象
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

此对象是从成功的 Geocoding Batch 服务调用返回的。
GeocodingBatchResponseSummaryOutput

批处理请求摘要
GeocodingResponseOutput

此对象是从成功的地理编码调用返回的
GeometryCopyrightOutput

边界对象的几何图形的版权信息。
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

结果的地址。
MapsSearchClientOptions

客户端的可选参数
ReverseGeocodingBatchRequestBody

要处理的反向地理编码查询/请求的列表。 该列表最多可以包含 100 个查询，并且必须至少包含 1 个查询。
ReverseGeocodingBatchRequestItem

Batch Query 对象
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

Get Geocoding API 是一个 HTTP GET 请求，它返回所搜索位置的经度和纬度坐标。

在许多情况下，完整的搜索服务可能太多，例如，如果只对传统地理编码感兴趣。 还可以专门访问搜索地址查找。 地理编码是通过仅使用地址或部分地址命中地理编码终结点来执行的。 将查询地理编码搜索索引，了解街道级别数据上方的所有内容。 不会返回任何兴趣点（POIS）。 请注意，地理编码器对拼写错误和不完整的地址非常宽容。 它还将处理确切的街道地址或街道或十字路口以及更高级别的地理区域，如市中心、县和州。 响应还返回详细的地址属性，如街道、邮政编码、市政当局和国家/地区信息。
SearchGetGeocodingBatch200Response

Get Geocoding Batch API 是一个 HTTP POST 请求，在单个请求中向 Geocoding API 发送多达 100 100 个 查询的批处理。

提交同步批处理请求

建议对轻型批处理请求使用同步 API。 当服务收到请求时，它会在计算批处理项后立即做出响应，并且以后将无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将返回超时错误（408 响应）。 批项数限制为此 API 100 个。

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

批处理请求的 POST 正文

若要发送 地理编码 查询，将使用 POST 请求，其中请求正文将包含 batchItems 格式的 json 数组，Content-Type 标头将设置为 application/json。 下面是包含 2 个 地理编码 查询的示例请求正文：

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

geocoding batchItem 对象可以接受任何受支持的 地理编码URI 参数。

批处理应至少包含 1 个 查询 。

批处理响应模型

批处理响应包含一个 summary 组件，该组件指示作为原始批处理请求的一部分的 totalRequests，successfulRequests 即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems 将包含结果，其顺序与在批处理请求中发送原始查询的顺序完全相同。 每个项都是以下类型之一：

  • GeocodingResponse - 如果查询成功完成。

  • Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Get Geocoding Batch API 是一个 HTTP POST 请求，在单个请求中向 Geocoding API 发送多达 100 100 个 查询的批处理。

提交同步批处理请求

建议对轻型批处理请求使用同步 API。 当服务收到请求时，它会在计算批处理项后立即做出响应，并且以后将无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将返回超时错误（408 响应）。 批项数限制为此 API 100 个。

POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01

批处理请求的 POST 正文

若要发送 地理编码 查询，将使用 POST 请求，其中请求正文将包含 batchItems 格式的 json 数组，Content-Type 标头将设置为 application/json。 下面是包含 2 个 地理编码 查询的示例请求正文：

{
  "batchItems": [
    {
      "addressLine": "One, Microsoft Way, Redmond, WA 98052",
      "top": 2
    },
    {
      "addressLine": "Pike Pl",
      "adminDistrict": "WA",
      "locality": "Seattle",
      "top": 3
    }
  ]
}

geocoding batchItem 对象可以接受任何受支持的 地理编码URI 参数。

批处理应至少包含 1 个 查询 。

批处理响应模型

批处理响应包含一个 summary 组件，该组件指示作为原始批处理请求的一部分的 totalRequests，successfulRequests 即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems 将包含结果，其顺序与在批处理请求中发送原始查询的顺序完全相同。 每个项都是以下类型之一：

  • GeocodingResponse - 如果查询成功完成。

  • Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Get Geocoding API 是一个 HTTP GET 请求，它返回所搜索位置的经度和纬度坐标。

在许多情况下，完整的搜索服务可能太多，例如，如果只对传统地理编码感兴趣。 还可以专门访问搜索地址查找。 地理编码是通过仅使用地址或部分地址命中地理编码终结点来执行的。 将查询地理编码搜索索引，了解街道级别数据上方的所有内容。 不会返回任何兴趣点（POIS）。 请注意，地理编码器对拼写错误和不完整的地址非常宽容。 它还将处理确切的街道地址或街道或十字路口以及更高级别的地理区域，如市中心、县和州。 响应还返回详细的地址属性，如街道、邮政编码、市政当局和国家/地区信息。
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

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

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

Get Reverse Geocoding API 是一个 HTTP GET 请求，用于将坐标（例如：37.786505、-122.3862）转换为人类可理解的街道地址。 可用于跟踪从设备或资产接收 GPS 源并想要知道与坐标关联的地址的应用程序。 此终结点将返回给定坐标的地址信息。
SearchGetReverseGeocodingBatch200Response

API 是一个 HTTP 请求，它使用单个请求向反向地理编码 API 发送多达 100 个 100 个 查询的批处理。

提交同步批处理请求

建议对轻型批处理请求使用同步 API。 当服务收到请求时，它会在计算批处理项后立即做出响应，并且以后将无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将返回超时错误（408 响应）。 批项数限制为此 API 100 个。

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

批处理请求的 POST 正文

若要发送 反向地理编码 查询，将使用 POST 请求，其中请求正文将包含 batchItems 格式的 json 数组，Content-Type 标头将设置为 application/json。 下面是一个示例请求正文，其中包含 2 个 反向地理编码 查询：

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

反向地理编码 batchItem 对象可以接受任何受支持的 反向地理编码URI 参数。

批处理应至少包含 1 个 查询 。

批处理响应模型

批处理响应包含一个 summary 组件，该组件指示作为原始批处理请求的一部分的 totalRequests，successfulRequests 即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems 将包含结果，其顺序与在批处理请求中发送原始查询的顺序完全相同。 每个项都是以下类型之一：

  • GeocodingResponse - 如果查询成功完成。

  • Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。
SearchGetReverseGeocodingBatchBodyParam
SearchGetReverseGeocodingBatchDefaultResponse

API 是一个 HTTP 请求，它使用单个请求向反向地理编码 API 发送多达 100 个 100 个 查询的批处理。

提交同步批处理请求

建议对轻型批处理请求使用同步 API。 当服务收到请求时，它会在计算批处理项后立即做出响应，并且以后将无法检索结果。 如果请求花费的时间超过 60 秒，同步 API 将返回超时错误（408 响应）。 批项数限制为此 API 100 个。

POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01

批处理请求的 POST 正文

若要发送 反向地理编码 查询，将使用 POST 请求，其中请求正文将包含 batchItems 格式的 json 数组，Content-Type 标头将设置为 application/json。 下面是一个示例请求正文，其中包含 2 个 反向地理编码 查询：

{
  "batchItems": [
    {
      "coordinates": [-122.128275, 47.639429],
      "resultTypes": ["Address", "PopulatedPlace"]
    },
    {
      "coordinates": [-122.341979399674, 47.6095253501216]
    }
  ]
}

反向地理编码 batchItem 对象可以接受任何受支持的 反向地理编码URI 参数。

批处理应至少包含 1 个 查询 。

批处理响应模型

批处理响应包含一个 summary 组件，该组件指示作为原始批处理请求的一部分的 totalRequests，successfulRequests 即已成功执行的查询。 批处理响应还包括一个 batchItems 数组，其中包含批处理请求中每个查询的响应。 batchItems 将包含结果，其顺序与在批处理请求中发送原始查询的顺序完全相同。 每个项都是以下类型之一：

  • GeocodingResponse - 如果查询成功完成。

  • Error - 如果查询失败。 在这种情况下，响应将包含 code 和 message。
SearchGetReverseGeocodingBatchMediaTypesParam
SearchGetReverseGeocodingDefaultResponse

Get Reverse Geocoding API 是一个 HTTP GET 请求，用于将坐标（例如：37.786505、-122.3862）转换为人类可理解的街道地址。 可用于跟踪从设备或资产接收 GPS 源并想要知道与坐标关联的地址的应用程序。 此终结点将返回给定坐标的地址信息。
SearchGetReverseGeocodingQueryParam
SearchGetReverseGeocodingQueryParamProperties

类型别名

GeoJsonFeatureOutput

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

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

有效的 GeoJSON 对象。 有关详细信息，请参阅 RFC 7946。
MapsSearchClient
SearchGetGeocodingBatchParameters
SearchGetGeocodingParameters
SearchGetPolygonParameters
SearchGetReverseGeocodingBatchParameters
SearchGetReverseGeocodingParameters

函数

default(AzureKeyCredential, ClientOptions)

从订阅密钥创建 MapsSearchClient 的实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);
default(TokenCredential, string, ClientOptions)

从 Azure 标识 TokenCredential创建 MapsSearch 实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");
default(AzureSASCredential, ClientOptions)

从 Azure 标识 AzureSASCredential创建 MapsSearch 实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);
isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse)
isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse)
isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse)
isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse)
isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse)

函数详细信息

default(AzureKeyCredential, ClientOptions)

从订阅密钥创建 MapsSearchClient 的实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsSearch(credential);

function default(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient

参数

credential
AzureKeyCredential

用于对服务请求进行身份验证的 AzureKeyCredential 实例

options
ClientOptions

用于配置搜索客户端的选项

返回

MapsSearchClient

default(TokenCredential, string, ClientOptions)

从 Azure 标识 TokenCredential创建 MapsSearch 实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsSearch(credential, "<maps-account-client-id>");

function default(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient

参数

credential
TokenCredential

用于对服务的请求进行身份验证的 TokenCredential 实例

mapsAccountClientId

string

特定地图资源的 Azure Maps 客户端 ID

options
ClientOptions

用于配置搜索客户端的选项

返回

MapsSearchClient

default(AzureSASCredential, ClientOptions)

从 Azure 标识 AzureSASCredential创建 MapsSearch 实例。

示例

import MapsSearch from "@azure-rest/maps-search";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsSearch(credential);

function default(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient

参数

credential
AzureSASCredential

用于对服务的请求进行身份验证的 AzureSASCredential 实例

options
ClientOptions

用于配置搜索客户端的选项

返回

MapsSearchClient

isUnexpected(SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse): response

参数

response

SearchGetGeocoding200Response | SearchGetGeocodingDefaultResponse

返回

response

isUnexpected(SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse): response

参数

response

SearchGetGeocodingBatch200Response | SearchGetGeocodingBatchDefaultResponse

返回

response

isUnexpected(SearchGetPolygon200Response | SearchGetPolygonDefaultResponse) 

function isUnexpected(response: SearchGetPolygon200Response | SearchGetPolygonDefaultResponse): response

参数

response

SearchGetPolygon200Response | SearchGetPolygonDefaultResponse

返回

response

isUnexpected(SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse): response

参数

response

SearchGetReverseGeocoding200Response | SearchGetReverseGeocodingDefaultResponse

返回

response

isUnexpected(SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse) 

function isUnexpected(response: SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse): response

参数

response

SearchGetReverseGeocodingBatch200Response | SearchGetReverseGeocodingBatchDefaultResponse

返回

response