@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

Объект пакетного запроса
GeocodingBatchResponseItemOutput
GeocodingBatchResponseOutput

Этот объект возвращается из успешного вызова пакетной службы geocoding.
GeocodingBatchResponseSummaryOutput

Сводка по пакетным запросам
GeocodingResponseOutput

Этот объект возвращается из успешного вызова геокодирования.
GeometryCopyrightOutput

Сведения об авторских правах на геометрию объекта Boundary.
GetGeocoding
GetGeocodingBatch
GetPolygon
GetReverseGeocoding
GetReverseGeocodingBatch
IntersectionOutput

Адрес результата.
ReverseGeocodingBatchRequestBody

Список запросов и запросов обратного геокодирования для обработки. Список может содержать не более 100 запросов и должен содержать по крайней мере 1 запрос.
ReverseGeocodingBatchRequestItem

Объект пакетного запроса
Routes
SearchGetGeocoding200Headers
SearchGetGeocoding200Response

Геокодирование

Применимо к: см. ценовые категории.

Во многих случаях полная служба поиска может оказаться слишком большой, например, если вас интересует только традиционное геокодирование. Поиск также можно получить исключительно для поиска адреса. Геокодирование выполняется путем попадания в конечную точку геокодирования только с указанным адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие точки интереса (POIS) не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д.
SearchGetGeocodingBatch200Response

Api пакетной службы геокодирования

Применимо к: см. ценовые категории.

API пакетной службы геокодирования отправляет пакеты запросов в API геокодирования , используя только один вызов API. API позволяет вызывающей службе пакетировать до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется использовать для упрощенных пакетных запросов. Когда служба получит запрос, она ответит сразу после вычисления элементов пакета, и позже получить результаты не будет. Синхронный API вернет ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Количество элементов пакета ограничено 100 для этого API.

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
    }
  ]
}

Объект batchItem для геокодирования может принимать любые поддерживаемые параметры URIгеокодирования.

Пакет должен содержать по крайней мере 1 запрос.

Модель пакетного ответа

Пакетный ответ содержит summary компонент , который указывает totalRequests , которые были частью исходного пакетного запроса, и successfulRequests т. е. запросы, которые были успешно выполнены. Пакетный ответ также содержит batchItems массив, содержащий ответ для каждого запроса в пакетном запросе. Будет batchItems содержать результаты в том же порядке, в котором исходные запросы были отправлены в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • GeocodingResponse — если запрос выполнен успешно.

  • Error — Если запрос завершился ошибкой. В этом случае ответ будет содержать code и message .
SearchGetGeocodingBatchBodyParam
SearchGetGeocodingBatchDefaultResponse

Api пакетной службы геокодирования

Применимо к: см. ценовые категории.

API пакетной службы геокодирования отправляет пакеты запросов в API геокодирования , используя только один вызов API. API позволяет вызывающей службе пакетировать до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный API рекомендуется использовать для упрощенных пакетных запросов. Когда служба получит запрос, она ответит сразу после вычисления элементов пакета, и позже получить результаты не будет. Синхронный API вернет ошибку времени ожидания (ответ 408), если запрос занимает больше 60 секунд. Количество элементов пакета ограничено 100 для этого API.

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
    }
  ]
}

Объект batchItem для геокодирования может принимать любые поддерживаемые параметры URIгеокодирования.

Пакет должен содержать по крайней мере 1 запрос.

Модель пакетного ответа

Пакетный ответ содержит summary компонент , который указывает totalRequests , которые были частью исходного пакетного запроса, и successfulRequests т. е. запросы, которые были успешно выполнены. Пакетный ответ также содержит batchItems массив, содержащий ответ для каждого запроса в пакетном запросе. Будет batchItems содержать результаты в том же порядке, в котором исходные запросы были отправлены в пакетном запросе. Каждый элемент имеет один из следующих типов:

  • GeocodingResponse — если запрос выполнен успешно.

  • Error — Если запрос завершился ошибкой. В этом случае ответ будет содержать code и message .
SearchGetGeocodingBatchMediaTypesParam
SearchGetGeocodingDefaultResponse

Геокодирование

Применимо к: см. ценовые категории.

Во многих случаях полная служба поиска может оказаться слишком большой, например, если вас интересует только традиционное геокодирование. Поиск также можно получить исключительно для поиска адреса. Геокодирование выполняется путем попадания в конечную точку геокодирования только с указанным адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие точки интереса (POIS) не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д.
SearchGetGeocodingQueryParam
SearchGetGeocodingQueryParamProperties
SearchGetPolygon200Response

Получение многоугольника

Применимо к: см. ценовые категории.

Предоставляет данные многоугольников очертания географической области, например города или региона страны.
SearchGetPolygonDefaultResponse

Получение многоугольника

Применимо к: см. ценовые категории.

Предоставляет данные многоугольников очертания географической области, например города или региона страны.
SearchGetPolygonQueryParam
SearchGetPolygonQueryParamProperties
SearchGetReverseGeocoding200Response

Обратное геокодирование

Применимо к: см. ценовые категории.

Преобразуйте координату (например, 37,786505, -122,3862) в понятный человеку адрес. Чаще всего это необходимо в приложениях отслеживания, в которых вы получаете gps-канал от устройства или ресурса и хотите узнать, по какому адресу расположена координата. Эта конечная точка возвращает сведения об адресе для заданной координаты.
SearchGetReverseGeocodingBatch200Response

API пакетной службы обратного геокодирования

Применимо к: см. ценовые категории.

API пакетной службы обратного геокодирования отправляет пакеты запросов в API обратного геокодирования , используя только один вызов API. API позволяет вызывающей службе пакетировать до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный 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 пакетной службы обратного геокодирования

Применимо к: см. ценовые категории.

API пакетной службы обратного геокодирования отправляет пакеты запросов в API обратного геокодирования , используя только один вызов API. API позволяет вызывающей службе пакетировать до 100 запросов.

Отправка синхронного пакетного запроса

Синхронный 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

Обратное геокодирование

Применимо к: см. ценовые категории.

Преобразуйте координату (например, 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 из удостоверения TokenCredentialAzure .

Пример

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 из удостоверения AzureSASCredentialAzure .

Пример

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 из удостоверения TokenCredentialAzure .

Пример

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 из удостоверения AzureSASCredentialAzure .

Пример

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