共用方式為

@azure-rest/maps-search package

  • 參考

介面

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput

結果的位址
BoundaryOutput

GeoJSON GeocodingFeature 物件，描述地理區域的界限。 特徵的幾何描述 GeoJSON GeometryCollection。

請注意，服務通常會傳回具有Polygon或 MultiPolygon 子類型的GeometryCollection。
BoundaryPropertiesOutput

Boundary 對象的屬性。
ErrorAdditionalInfoOutput

資源管理錯誤其他資訊。
ErrorDetailOutput

錯誤詳細數據。
ErrorResponseOutput

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
FeaturesItemOutput
FeaturesItemPropertiesOutput
GeoJsonFeatureCollectionDataOutput
GeoJsonFeatureCollectionOutput

有效的 GeoJSON FeatureCollection 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonFeatureDataOutput
GeoJsonFeatureOutputParent

有效的 GeoJSON Feature 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometryCollectionDataOutput
GeoJsonGeometryCollectionOutput

有效的 GeoJSON GeometryCollection 物件類型。 如需詳細資訊，請參閱 RFC 7946。
GeoJsonGeometryOutputParent

有效的 GeoJSON geometry 物件。 此類型必須是七個有效的 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

Boundary 對象的幾何著作權資訊。
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 要求，可將最多 100 個 查詢批次傳送至單一要求中的 Geocoding API。

提交同步批次要求

針對輕量型批次要求，建議使用同步 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 要求，可將最多 100 個 查詢批次傳送至單一要求中的 Geocoding API。

提交同步批次要求

針對輕量型批次要求，建議使用同步 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

Get Reverse Geocoding Batch API 是 HTTP POST 要求，會使用單一要求，將最多 100 個 查詢批次傳送至 反向地理編碼 API。

提交同步批次要求

針對輕量型批次要求，建議使用同步 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

Get Reverse Geocoding Batch API 是 HTTP POST 要求，會使用單一要求，將最多 100 個 查詢批次傳送至 反向地理編碼 API。

提交同步批次要求

針對輕量型批次要求，建議使用同步 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 geometry 物件。 此類型必須是七個有效的 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 地圖服務用戶端識別碼

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