Search - Get Search Polygon

Ссылка

Служба:: Maps

Версия API:: 1.0

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

API Get Polygon — это запрос HTTP GET, который возвращает геометрические данные, такие как город или страна или регион для набора сущностей, ранее полученных из запроса поиска в Интернете в формате GeoJSON. Идентификатор геометрии возвращается в объекте sourceGeometry в разделе "geometry" и "id" в вызове "Адрес поиска" или "Поиск нечетких".

Идентификатор геометрии, полученный из конечной точки поиска в Интернете, имеет ограниченное время существования, не рекомендуется хранить идентификаторы геометрии в постоянном хранилище для последующей ссылки. Ожидается, что запрос к методу Polygon выполняется в течение нескольких минут после запроса к методу поиска в Интернете, который предоставил идентификатор. Служба позволяет выполнять пакетные запросы до 20 идентификаторов.

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}

Параметры URI

Имя	В	Обязательно	Тип	Описание
format	path	True	JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
api-version	query	True	string	Номер версии API Azure Maps.
geometries	query	True	string[]	Разделенный запятыми список геометрических UUID, ранее полученный из запроса поиска в Интернете.

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-client-id		string	Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности идентификатора Microsoft Entra. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения о том, как использовать безопасность идентификатора Microsoft Entra в Azure Maps, см. в следующих статьях .

Ответы

Имя	Тип	Описание
200 OK	PolygonResult	ХОРОШО
Other Status Codes	ErrorResponse	Произошла непредвиденная ошибка.

Безопасность

AADToken

Это потоки Microsoft Entra OAuth 2.0. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечание.

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить из API управления карт.
Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации идентификатора Microsoft Entra.
Управление доступом на основе ролей Azure настраивается на основе плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
Использование веб-пакета SDK для Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.
Дополнительные сведения о платформе удостоверений Майкрософт см. в обзоре платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Это общий ключ, подготовленный при создания учетной записи Azure Maps на портале Azure или с помощью PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого ключа любой приложение может получить доступ ко всем REST API. Другими словами, этот ключ можно использовать в качестве главного ключа в учетной записи, в которую они выданы.

Для общедоступных приложений мы рекомендуем использовать конфиденциальные клиентские приложения, подход для доступа к REST API Azure Maps, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: query

SAS Token

Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.

С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.

Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.

Тип: apiKey
В: header

Примеры

Get the Geometry using the geometry id returned by the previous Search

Образец запроса

HTTP

GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca

Пример ответа

Код состояния:: 200

{
  "additionalData": [
    {
      "providerID": "1111-2222-32-4444444444444",
      "geometryData": {
        "type": "FeatureCollection",
        "features": [
          {
            "type": "Feature",
            "properties": {},
            "geometry": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    -122.0665062,
                    47.6496252
                  ],
                  [
                    -122.0664863,
                    47.6496113
                  ],
                  [
                    -122.0664843,
                    47.6496014
                  ],
                  [
                    -122.0663693,
                    47.6495247
                  ],
                  [
                    -122.0663017,
                    47.6494664
                  ],
                  [
                    -122.0662679,
                    47.6494247
                  ],
                  [
                    -122.0661647,
                    47.6493314
                  ],
                  [
                    -122.067177,
                    47.649298
                  ],
                  [
                    -122.090715,
                    47.6543598
                  ],
                  [
                    -122.0907846,
                    47.6542921
                  ],
                  [
                    -122.0908284,
                    47.6542603
                  ]
                ]
              ]
            },
            "id": "1111-2222-32-4444444444444"
          }
        ]
      }
    }
  ]
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
GeoJsonFeature	Допустимый тип объекта `GeoJSON Feature`. Дополнительные сведения см. в RFC 7946.
GeoJsonFeatureCollection	Допустимый тип объекта `GeoJSON FeatureCollection`. Дополнительные сведения см. в RFC 7946.
GeoJsonGeometry	Допустимый объект `GeoJSON` геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
GeoJsonGeometryCollection	Допустимый тип объекта `GeoJSON GeometryCollection`. Дополнительные сведения см. в RFC 7946.
GeoJsonLineString	Допустимый тип геометрии `GeoJSON LineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiLineString	Допустимый тип геометрии `GeoJSON MultiLineString`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPoint	Допустимый тип геометрии `GeoJSON MultiPoint`. Дополнительные сведения см. в RFC 7946.
GeoJsonMultiPolygon	Допустимый тип объекта `GeoJSON MultiPolygon`. Дополнительные сведения см. в RFC 7946.
GeoJsonPoint	Допустимый тип геометрии `GeoJSON Point`. Дополнительные сведения см. в RFC 7946.
GeoJsonPolygon	Допустимый тип геометрии `GeoJSON Polygon`. Дополнительные сведения см. в RFC 7946.
JsonFormat	Требуемый формат ответа. Поддерживается только `json` формат.
Polygon
PolygonResult	Этот объект возвращается из успешного вызова Polygon поиска

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

GeoJsonFeature

Object

Допустимый тип объекта GeoJSON Feature. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
featureType	string	Тип функции. Значение зависит от модели данных, из которой входит текущая функция. Некоторые модели данных могут иметь пустое значение.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Допустимый объект `GeoJSON` геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
id	string	Идентификатор функции.
type	string: Feature	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonFeatureCollection

Object

Допустимый тип объекта GeoJSON FeatureCollection. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
features	GeoJsonFeature[]	Содержит список допустимых объектов `GeoJSON Feature`.
type	string: FeatureCollection	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometry

Object

Допустимый объект GeoJSON геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
type	GeoJsonObjectType	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonGeometryCollection

Object

Допустимый тип объекта GeoJSON GeometryCollection. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Содержит список допустимых `GeoJSON` геометрических объектов. примечание координат в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: GeometryCollection	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonLineString

Object

Допустимый тип геометрии GeoJSON LineString. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson LineString`.
type	string: LineString	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiLineString

Object

Допустимый тип геометрии GeoJSON MultiLineString. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson MultiLineString`.
type	string: MultiLineString	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPoint

Object

Допустимый тип геометрии GeoJSON MultiPoint. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты геометрии `GeoJson MultiPoint`.
type	string: MultiPoint	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonMultiPolygon

Object

Допустимый тип объекта GeoJSON MultiPolygon. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Содержит список допустимых объектов `GeoJSON Polygon`. примечание координат в GeoJSON находятся в порядке x, y (долгота, широта).
type	string: MultiPolygon	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPoint

Object

Допустимый тип геометрии GeoJSON Point. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	`Position` — это массив чисел с двумя или более элементами. Первые два элемента — это долготы и широты, точно в этом порядке. высоты или высоты является необязательным третьим элементом. Дополнительные сведения см. в RFC 7946.
type	string: Point	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

GeoJsonPolygon

Object

Допустимый тип геометрии GeoJSON Polygon. Дополнительные сведения см. в RFC 7946.

Имя	Тип	Описание
coordinates	number[] (double)	Координаты для типа геометрии `GeoJson Polygon`.
type	string: Polygon	Указывает тип `GeoJSON`. Должен быть одним из девяти допустимых типов объектов GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature и FeatureCollection.

JsonFormat

Перечисление

Требуемый формат ответа. Поддерживается только json формат.

Значение	Описание
json	формат обмена данными для объектов JavaScript

Polygon

Object

Имя	Тип	Описание
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Данные геометрии в формате GeoJSON. Дополнительные сведения см. в RFC 7946. Присутствует только в том случае, если "ошибка" отсутствует.
providerID	string	Идентификатор возвращаемой сущности

PolygonResult

Object

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

Имя	Тип	Описание
additionalData	Polygon[]	Массив результатов

Поделиться через

Search - Get Search Polygon

Параметры URI

Заголовок запроса

Ответы

Безопасность

AADToken

Области

subscription-key

SAS Token

Примеры

Get the Geometry using the geometry id returned by the previous Search

Образец запроса

Пример ответа

Определения

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonFeature

GeoJsonFeatureCollection

GeoJsonGeometry

GeoJsonGeometryCollection

GeoJsonLineString

GeoJsonMultiLineString

GeoJsonMultiPoint

GeoJsonMultiPolygon

GeoJsonPoint

GeoJsonPolygon

JsonFormat

Polygon

PolygonResult

Дополнительные ресурсы