@azure-rest/maps-search package

Интерфейсы

AddressAdminDistrictsItemOutput
AddressCountryRegionOutput
AddressOutput	Адрес результата
BoundaryOutput	GeoJSON GeocodingFeature объект, описывающий границы географической области. Геометрия функции описана GeoJSON GeometryCollection. Обратите внимание, что служба обычно возвращает GeometryCollection с подтипами Polygon или MultiPolygon.
BoundaryPropertiesOutput	Свойства объекта Boundary.
ErrorAdditionalInfoOutput	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetailOutput	Сведения об ошибке.
ErrorResponseOutput	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках 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.
GeocodingBatchResponseSummaryOutput	Сводка для пакетного запроса
GeocodingResponseOutput	Этот объект возвращается из успешного вызова Geocoding
GeometryCopyrightOutput	Сведения об авторских правах геометрии объекта Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput	Адрес результата.
MapsSearchClientOptions	Необязательные параметры для клиента
ReverseGeocodingBatchRequestBody	Список запросов и запросов обратного геокодирования для обработки. Список может содержать не более 100 запросов и должен содержать не менее 1 запроса.
ReverseGeocodingBatchRequestItem	Объект Batch Query
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response	API Get Geocoding — это запрос HTTP GET, который возвращает координаты долготы и широты поиска расположения. Во многих случаях полная служба поиска может быть слишком много, например, если вы заинтересованы только в традиционном геокодирование. Поиск также можно получить только для поиска адресов. Геокодирование выполняется путем попадания в конечную точку геокодирования только с адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных над данными уровня улицы. Не будет возвращена точка интереса (POIS). Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все от точных уличных адресов или улиц или пересечений, а также более высокого уровня географических регионов, таких как городские центры, округа и штаты. Ответ также возвращает подробные свойства адреса, такие как улица, почтовый индекс, муниципалитет и информация о стране или регионе.
SearchGetGeocodingBatch200Response	API Get Geocoding Batch — это HTTP-запрос POST, который отправляет пакеты до 100 запросов в API геокод ирования в одном запросе. Отправка синхронного пакетного запроса Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Текст POST для пакетного запроса Для отправки запросов геокодирования используется запрос , в котором текст запроса будет содержать массив в формате , а заголовок будет иметь значение . Ниже приведен пример текста запроса, содержащего 2 геокодирования запросов: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Объект геокодирования batchItem может принимать любой из поддерживаемых параметров геокодированияURI. Пакет должен содержать по крайней мере 1 запроса. Модель пакетного ответа Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов: GeocodingResponse. Если запрос выполнен успешно. Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse	API Get Geocoding Batch — это HTTP-запрос POST, который отправляет пакеты до 100 запросов в API геокод ирования в одном запросе. Отправка синхронного пакетного запроса Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API. POST https://atlas.microsoft.com/geocode:batch?api-version=2023-06-01 Текст POST для пакетного запроса Для отправки запросов геокодирования используется запрос , в котором текст запроса будет содержать массив в формате , а заголовок будет иметь значение . Ниже приведен пример текста запроса, содержащего 2 геокодирования запросов: { "batchItems": [ { "addressLine": "One, Microsoft Way, Redmond, WA 98052", "top": 2 }, { "addressLine": "Pike Pl", "adminDistrict": "WA", "locality": "Seattle", "top": 3 } ] } Объект геокодирования batchItem может принимать любой из поддерживаемых параметров геокодированияURI. Пакет должен содержать по крайней мере 1 запроса. Модель пакетного ответа Пакетный ответ содержит компонент summary, указывающий totalRequests, которые были частью исходного пакетного запроса и successfulRequests то есть запросы, которые были выполнены успешно. Пакетный ответ также содержит массив batchItems, содержащий ответ для каждого запроса и каждого запроса в пакетном запросе. batchItems будет содержать результаты в том же порядке, что и исходные запросы, отправленные в пакетном запросе. Каждый элемент имеет один из следующих типов: GeocodingResponse. Если запрос выполнен успешно. Error — если запрос завершился ошибкой. Ответ будет содержать code и message в этом случае.
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse	API Get Geocoding — это запрос HTTP GET, который возвращает координаты долготы и широты поиска расположения. Во многих случаях полная служба поиска может быть слишком много, например, если вы заинтересованы только в традиционном геокодирование. Поиск также можно получить только для поиска адресов. Геокодирование выполняется путем попадания в конечную точку геокодирования только с адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных над данными уровня улицы. Не будет возвращена точка интереса (POIS). Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все от точных уличных адресов или улиц или пересечений, а также более высокого уровня географических регионов, таких как городские центры, округа и штаты. Ответ также возвращает подробные свойства адреса, такие как улица, почтовый индекс, муниципалитет и информация о стране или регионе.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response	API Get Polygon — это запрос HTTP GET, который предоставляет многоугольники данных географической области, например города или региона страны.
SearchGetPolygonDefaultResponse	API Get Polygon — это запрос HTTP GET, который предоставляет многоугольники данных географической области, например города или региона страны.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response	API Get Reverse Geocoding — это запрос HTTP GET, используемый для перевода координат (например, 37.786505, -122.3862) в понятный почтовый адрес человека. Полезно в отслеживании приложений, где вы получаете GPS-канал от устройства или ресурса и хотите знать адрес, связанный с координатами. Эта конечная точка вернет сведения об адресе для заданной координаты.
SearchGetReverseGeocodingBatch200Response	API Get Reverse Geocoding Batch — это http-запрос POST, который отправляет пакеты до 100 запросов в обратное геокодирование API с помощью одного запроса. Отправка синхронного пакетного запроса Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API. 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 Get Reverse Geocoding Batch — это http-запрос POST, который отправляет пакеты до 100 запросов в обратное геокодирование API с помощью одного запроса. Отправка синхронного пакетного запроса Синхронный API рекомендуется для упрощенных пакетных запросов. Когда служба получает запрос, он ответит сразу после вычисления пакетных элементов и не сможет получить результаты позже. Синхронный API возвращает ошибку времени ожидания (ответ 408), если запрос занимает более 60 секунд. Количество пакетных элементов ограничено 100 для этого API. 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	API Get Reverse Geocoding — это запрос 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)	Создает экземпляр MapsSearch из TokenCredentialудостоверений Azure. Пример 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)	Создает экземпляр MapsSearch из AzureSASCredentialудостоверений Azure. Пример 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)

Создает экземпляр MapsSearch из TokenCredentialудостоверений Azure.

Пример

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 определенного ресурса карты

options

ClientOptions

Параметры, используемые для настройки клиента поиска

Возвращаемое значение

MapsSearchClient

default(AzureSASCredential, ClientOptions)

Создает экземпляр MapsSearch из AzureSASCredentialудостоверений Azure.

Пример

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