Share via

Search - Get Search Polygon

  • Ссылка
Service:
Maps
API Version:
1.0

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

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

Идентификатор геометрии, полученный из конечной точки поиска в Интернете, имеет ограниченный срок существования. Не рекомендуется хранить геометрические идентификаторы в постоянном хранилище для последующей передачи. Ожидается, что запрос к методу 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[]

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

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

Имя Обязательно Тип Описание
x-ms-client-id

string

Указывает учетную запись, предназначенную для использования в сочетании с моделью безопасности Microsoft Entra ID. Он представляет уникальный идентификатор для учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Инструкции по использованию Microsoft Entra ID безопасности в Azure Maps см. в следующих статьях.

Ответы

Имя Тип Описание
200 OK

PolygonResult

ОК
Other Status Codes

ErrorResponse

Произошла непредвиденная ошибка.

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

AADToken

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

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

Примечание

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

Примеры

Sample Request

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

Sample Response

Status code:
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

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

GeoJsonFeature

Допустимый 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

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

Имя Тип Описание
features

GeoJsonFeature[]

Содержит список допустимых GeoJSON Feature объектов.
type string:

FeatureCollection

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

GeoJsonGeometry

Допустимый 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

Допустимый 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

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

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson LineString .
type string:

LineString

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

GeoJsonMultiLineString

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

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiLineString .
type string:

MultiLineString

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

GeoJsonMultiPoint

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

Имя Тип Описание
coordinates

number[]

Координаты геометрии GeoJson MultiPoint .
type string:

MultiPoint

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

GeoJsonMultiPolygon

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

Имя Тип Описание
coordinates

number[]

Содержит список допустимых GeoJSON Polygon объектов. Обратите внимание , что координаты в GeoJSON находятся в порядке x, y (долгота, широта).
type string:

MultiPolygon

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

GeoJsonPoint

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

Имя Тип Описание
coordinates

number[]

— Position это массив чисел с двумя или более элементами. Первые два элемента — долгота и широта, именно в этом порядке. Высота или высота — необязательный третий элемент. Дополнительные сведения см. в документе RFC 7946 .
type string:

Point

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

GeoJsonPolygon

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

Имя Тип Описание
coordinates

number[]

Координаты для GeoJson Polygon типа geometry.
type string:

Polygon

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

JsonFormat

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

Имя Тип Описание
json

string

Формат обмена данными нотации объектов JavaScript

Polygon

Имя Тип Описание
geometryData GeoJsonObject:
  • GeoJsonFeature
  • GeoJsonFeatureCollection

Геометрические данные в формате GeoJSON. Дополнительные сведения см. в документе RFC 7946 . Отображается только в том случае, если отсутствует ошибка.
providerID

string

Идентификатор возвращаемой сущности

PolygonResult

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

Имя Тип Описание
additionalData

Polygon[]

Массив результатов