Search - Get Polygon
Используется для получения данных многоугольника географической области, например города или региона страны.
API Get Polygon
— это запрос HTTP GET
, который предоставляет многоугольники данных географической области, например города или региона страны.
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
api-version
|
query | True |
string |
Номер версии API Azure Maps. |
coordinates
|
query | True |
number[] |
Точка на земле, указанная в виде долготы и широты. Пример: координаты &=lon,lat |
resolution
|
query |
Разрешение определяет количество точек для отправки обратно. Если значение не указано, по умолчанию используется среднее разрешение. |
||
result
|
query |
Геополитическая концепция возвращения границы. Если значение не указано, значение по умолчанию — |
||
view
|
query |
string |
Строка, представляющая код региона илистраны ISO 3166-1 Альфа-2. Это изменит геополитические спорные границы и метки, чтобы выровняться с указанным регионом пользователя. По умолчанию параметр View имеет значение Auto, даже если он не определен в запросе. Дополнительные сведения о доступных представлениях см. в поддерживаемых представлений. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
x-ms-client-id |
string |
Указывает, какая учетная запись предназначена для использования в сочетании с моделью безопасности Azure AD. Он представляет уникальный идентификатор учетной записи Azure Maps и может быть получен из API учетной записи уровня управления Azure Maps. Сведения об использовании безопасности Azure AD в Azure Maps см. в следующих статьях для получения рекомендаций. |
|
Accept-Language |
string |
Язык, в котором должны быть возвращены результаты поиска. Дополнительные сведения см. в поддерживаемых языках. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ХОРОШО Media Types: "application/geo+json" |
|
Other Status Codes |
Произошла непредвиденная ошибка. Media Types: "application/geo+json" |
Безопасность
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 с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого ключа любой приложению разрешен доступ ко всем REST API. Другими словами, они в настоящее время могут рассматриваться как главные ключи учетной записи, для которой они выданы.
Для общедоступных приложений мы рекомендуем использовать доступ к REST API Azure Maps на сервере, где этот ключ можно безопасно хранить.
Тип:
apiKey
В:
header
SAS Token
Это маркер подписанного URL-адреса создается из операции SAS списка на ресурсе Azure Maps через плоскость управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API.
С помощью этого маркера любой приложению разрешен доступ с помощью управления доступом на основе ролей Azure и точного управления сроком действия, скоростью и регионами, используемыми для конкретного маркера. Другими словами, маркер SAS можно использовать для разрешения приложений управлять доступом более защищенным способом, чем общий ключ.
Для общедоступных приложений мы рекомендуем настроить определенный список разрешенных источников в ресурсе учетной записи карты карты, чтобы ограничить злоупотребление отрисовкой и регулярно обновлять маркер SAS.
Тип:
apiKey
В:
header
Примеры
Get polygon for a city at coordinates -122.204141,47.612560
Образец запроса
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Пример ответа
Content-Type: application/geo+json
{
"type": "Feature",
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.13035,
47.53502
],
[
-122.12882,
47.53567
],
[
-122.12638000000001,
47.535140000000006
],
[
-122.12378000000001,
47.53717
],
[
-122.12068000000001,
47.537620000000004
],
[
-122.12028000000001,
47.538000000000004
],
[
-122.11682,
47.537940000000006
],
[
-122.11527000000001,
47.53609
],
[
-122.11119000000001,
47.536080000000005
],
[
-122.11103000000001,
47.539280000000005
],
[
-122.10832,
47.539530000000006
],
[
-122.10830000000001,
47.54057
],
[
-122.11006,
47.54055
],
[
-122.10999000000001,
47.542640000000006
],
[
-122.11185,
47.54298000000001
],
[
-122.11183000000001,
47.54426
],
[
-122.1114,
47.543800000000005
],
[
-122.10936000000001,
47.54379
],
[
-122.10912,
47.54462
],
[
-122.10745000000001,
47.544830000000005
],
[
-122.10808000000002,
47.545190000000005
],
[
-122.10808000000002,
47.54656000000001
],
[
-122.10665000000002,
47.546580000000006
],
[
-122.10711,
47.544700000000006
],
[
-122.10530000000001,
47.54473
],
[
-122.1054,
47.546910000000004
],
[
-122.10434000000001,
47.54693
],
[
-122.10433,
47.544830000000005
],
[
-122.10056000000002,
47.544940000000004
],
[
-122.1007,
47.548500000000004
],
[
-122.10194000000001,
47.54849
],
[
-122.10194000000001,
47.54883
],
[
-122.10194000000001,
47.549510000000005
],
[
-122.10071,
47.54883
],
[
-122.10048,
47.54849
],
[
-122.10047000000002,
47.54883
],
[
-122.10038000000002,
47.55904
],
[
-122.09796000000001,
47.55923000000001
],
[
-122.09870000000001,
47.560570000000006
],
[
-122.09818000000001,
47.56248
],
[
-122.10011000000002,
47.56839
],
[
-122.09876000000001,
47.56884
],
[
-122.09942000000001,
47.569900000000004
],
[
-122.09782000000001,
47.56983
],
[
-122.09672,
47.58019
],
[
-122.09885000000001,
47.58666
],
[
-122.09796000000001,
47.59503
],
[
-122.09664000000001,
47.602230000000006
],
[
-122.09411000000001,
47.607240000000004
],
[
-122.09104,
47.610240000000005
],
[
-122.08366000000001,
47.615660000000005
],
[
-122.08008000000001,
47.61939
],
[
-122.07904,
47.62201
],
[
-122.07959000000001,
47.627520000000004
],
[
-122.08008000000001,
47.627520000000004
],
[
-122.09181000000001,
47.627520000000004
],
[
-122.09221000000001,
47.62717000000001
],
[
-122.09256,
47.627520000000004
],
[
-122.11094000000001,
47.62765
],
[
-122.11091,
47.636720000000004
],
[
-122.11091,
47.64609
],
[
-122.11431,
47.646060000000006
],
[
-122.11437000000001,
47.64533
],
[
-122.11597,
47.64374
],
[
-122.12254000000001,
47.638510000000004
],
[
-122.12542,
47.636720000000004
],
[
-122.12809000000001,
47.635200000000005
],
[
-122.13241000000001,
47.63515
],
[
-122.13234000000001,
47.63268
],
[
-122.13407000000001,
47.63156000000001
],
[
-122.13484000000001,
47.62935
],
[
-122.13626000000001,
47.62820000000001
],
[
-122.1372,
47.627860000000005
],
[
-122.14184000000002,
47.62787
],
[
-122.14321000000001,
47.62713
],
[
-122.14312000000001,
47.636720000000004
],
[
-122.14335000000001,
47.660590000000006
],
[
-122.1641,
47.66077000000001
],
[
-122.16453000000001,
47.646370000000005
],
[
-122.16797000000001,
47.64621
],
[
-122.19629,
47.64643
],
[
-122.19629,
47.64289
],
[
-122.19846000000001,
47.642860000000006
],
[
-122.19846000000001,
47.64242
],
[
-122.19982000000002,
47.6424
],
[
-122.20169000000001,
47.644600000000004
],
[
-122.20341,
47.643190000000004
],
[
-122.20818000000001,
47.6435
],
[
-122.21014000000001,
47.643130000000006
],
[
-122.20962000000002,
47.642920000000004
],
[
-122.20974000000001,
47.636720000000004
],
[
-122.21005000000001,
47.62107
],
[
-122.22268000000001,
47.62106000000001
],
[
-122.22268000000001,
47.62066
],
[
-122.22203,
47.620470000000005
],
[
-122.22282000000001,
47.619890000000005
],
[
-122.22142000000001,
47.618570000000005
],
[
-122.22248,
47.61838
],
[
-122.22271,
47.617200000000004
],
[
-122.22136,
47.617180000000005
],
[
-122.21985000000001,
47.61643
],
[
-122.22044000000001,
47.614470000000004
],
[
-122.22033,
47.603840000000005
],
[
-122.22043000000001,
47.59682
],
[
-122.21702,
47.59038
],
[
-122.21653,
47.59042
],
[
-122.21572,
47.588240000000006
],
[
-122.21067000000001,
47.58375
],
[
-122.20153,
47.57887
],
[
-122.20227000000001,
47.57864000000001
],
[
-122.20132000000001,
47.578770000000006
],
[
-122.20034000000001,
47.57822
],
[
-122.19901000000002,
47.57592
],
[
-122.19923000000001,
47.567460000000004
],
[
-122.20034000000001,
47.55962
],
[
-122.20072,
47.55966
],
[
-122.20114000000001,
47.557520000000004
],
[
-122.20119000000001,
47.54943
],
[
-122.20160000000001,
47.549440000000004
],
[
-122.20167000000001,
47.54883
],
[
-122.20200000000001,
47.54609000000001
],
[
-122.19676000000001,
47.54621
],
[
-122.19545000000001,
47.54609000000001
],
[
-122.19545000000001,
47.545750000000005
],
[
-122.19091000000002,
47.54580000000001
],
[
-122.1907,
47.54216
],
[
-122.18581,
47.542100000000005
],
[
-122.18116,
47.541140000000006
],
[
-122.17142000000001,
47.54086
],
[
-122.16987,
47.54008
],
[
-122.16797000000001,
47.540060000000004
],
[
-122.16554000000001,
47.54005
],
[
-122.16439000000001,
47.54281
],
[
-122.16433,
47.545480000000005
],
[
-122.15356000000001,
47.54538
],
[
-122.15359000000001,
47.541760000000004
],
[
-122.14280000000001,
47.541520000000006
],
[
-122.14288,
47.539370000000005
],
[
-122.13645000000001,
47.53826
],
[
-122.13035,
47.53502
]
],
[
[
-122.19957000000001,
47.58372000000001
],
[
-122.20448,
47.583830000000006
],
[
-122.20585000000001,
47.586780000000005
],
[
-122.19654000000001,
47.586740000000006
],
[
-122.19655000000002,
47.58379
],
[
-122.19957000000001,
47.58372000000001
]
]
]
}
]
},
"properties": {
"name": "Bellevue",
"copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
"copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
"geometriesCopyright": [
{
"sourceName": "TOM",
"copyright": "TomTom"
}
]
}
}
Определения
Имя | Описание |
---|---|
Boundary |
Обратите внимание, что служба обычно возвращает GeometryCollection с подтипами Polygon или MultiPolygon. |
Boundary |
Свойства объекта Boundary. |
Boundary |
Геополитическая концепция возвращения границы. Если значение не указано, значение по умолчанию — |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Feature |
Тип компонента должен быть компонентом. |
Geo |
Допустимый объект |
Geo |
Допустимый тип объекта |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип объекта |
Geo |
Допустимый тип геометрии |
Geo |
Допустимый тип геометрии |
Geometry |
Сведения об авторских правах геометрии объекта Boundary. |
Resolution |
Разрешение определяет количество точек для отправки обратно. Если значение не указано, по умолчанию используется среднее разрешение. |
Boundary
GeoJSON GeocodingFeature
объект, описывающий границы географической области. Геометрия функции описана GeoJSON GeometryCollection
.
Обратите внимание, что служба обычно возвращает GeometryCollection с подтипами Polygon или MultiPolygon.
Имя | Тип | Описание |
---|---|---|
geometry |
Допустимый тип объекта |
|
properties |
Свойства объекта Boundary. |
|
type |
Тип компонента должен быть компонентом. |
BoundaryProperties
Свойства объекта Boundary.
Имя | Тип | Описание |
---|---|---|
copyright |
string |
Строка авторских прав. |
copyrightURL |
string |
URL-адрес, который содержит список многих поставщиков данных для Azure Maps и связанных с ними сведений об авторских правах. |
geometriesCopyright |
Коллекция сведений об авторских правах для каждой геометрии объекта Boundary в том же порядке, в который они отображаются. |
|
name |
string |
Имя, связанное с географической областью. |
BoundaryResultTypeEnum
Геополитическая концепция возвращения границы. Если значение не указано, значение по умолчанию — countryRegion
тип результата.
Имя | Тип | Описание |
---|---|---|
adminDistrict |
string |
Первый административный уровень в пределах страны или региона, например штата или провинции. |
adminDistrict2 |
string |
Второй административный уровень в пределах страны или региона, например округа. |
countryRegion |
string |
Страна или регион. |
locality |
string |
Сосредоточенная область человеческого поселения, например город, город или деревня. |
neighborhood |
string |
Раздел заполненного места, который обычно хорошо известен, но часто с неоткрытыми границами. |
postalCode |
string |
Наименьшая категория почтового кода, например почтовый индекс. |
postalCode2 |
string |
Следующая самая большая категория почтового кода после почтового кода, которая создается путем агрегирования областей почтового кода. |
postalCode3 |
string |
Следующая самая большая категория почтового кода после почтового кода2, которая создается путем агрегирования областей postCode2. |
postalCode4 |
string |
Следующая самая большая категория почтового кода после почтового кода3, которая создается путем агрегирования областей postCode3. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
FeatureTypeEnum
Тип компонента должен быть компонентом.
Имя | Тип | Описание |
---|---|---|
Feature |
string |
GeoJsonGeometry
Допустимый объект GeoJSON
геометрии. Тип должен быть одним из семи допустимых типов геометрии GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon и GeometryCollection. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
type |
Geo |
Указывает тип |
GeoJsonGeometryCollection
Допустимый тип объекта GeoJSON GeometryCollection
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
geometries | GeoJsonGeometry[]: |
Содержит список допустимых |
type |
string:
Geometry |
Указывает тип |
GeoJsonLineString
Допустимый тип геометрии GeoJSON LineString
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
Координаты геометрии |
type |
string:
Line |
Указывает тип |
GeoJsonMultiLineString
Допустимый тип геометрии GeoJSON MultiLineString
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
Координаты геометрии |
type |
string:
Multi |
Указывает тип |
GeoJsonMultiPoint
Допустимый тип геометрии GeoJSON MultiPoint
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
Координаты геометрии |
type |
string:
Multi |
Указывает тип |
GeoJsonMultiPolygon
Допустимый тип объекта GeoJSON MultiPolygon
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
Содержит список допустимых объектов |
type |
string:
Multi |
Указывает тип |
GeoJsonPoint
Допустимый тип геометрии GeoJSON Point
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
|
type |
string:
Point |
Указывает тип |
GeoJsonPolygon
Допустимый тип геометрии GeoJSON Polygon
. Дополнительные сведения см. в RFC 7946.
Имя | Тип | Описание |
---|---|---|
bbox |
number[] |
Ограничивающий прямоугольник. Используется проекция — EPSG:3857. Дополнительные сведения см. в RFC 7946. |
coordinates |
number[] |
Координаты для типа геометрии |
type |
string:
Polygon |
Указывает тип |
GeometryCopyright
Сведения об авторских правах геометрии объекта Boundary.
Имя | Тип | Описание |
---|---|---|
copyright |
string |
Строка авторских прав для поставщика данных |
sourceName |
string |
Имя поставщика данных |
ResolutionEnum
Разрешение определяет количество точек для отправки обратно. Если значение не указано, по умолчанию используется среднее разрешение.
Имя | Тип | Описание |
---|---|---|
huge |
string |
Возвращает геометрию границы с большим или большим количеством точек. |
large |
string |
Возвращает геометрию границы с большей или той же величиной точек, что и средний. |
medium |
string |
Возвращает геометрию границы с большим или одинаковым количеством точек, что и небольшое. |
small |
string |
Возвращает геометрию границы с наименьшим количеством точек. |