Search - Get Polygon
Use para obtener datos de polígono de una forma de área geográfica, como una ciudad o una región de país.
La Get Polygon API es una solicitud HTTP GET que proporciona datos de polígonos del contorno de un área geográfica, como una ciudad o una región de país.
GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}GET {endpoint}/search/polygon?api-version=2026-01-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
El nombre de host del servicio Azure Maps. Usa |
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
|
coordinates
|
query | True |
number[] |
Un punto en la tierra especificado como longitud y latitud. Ejemplo: &coordinates=lon,lat |
|
resolution
|
query |
La resolución determina la cantidad de puntos que se devuelven. Si no se especifica, el valor predeterminado es resolución media. |
||
|
result
|
query |
El concepto geopolítico para devolver un límite. Si no se especifica, el valor predeterminado es |
||
|
view
|
query |
string |
Cadena que representa un código de país o región ISO 3166-1 Alpha-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto" incluso si no lo ha definido en la solicitud. Consulte vistas admitidas para obtener más información y ver las vistas disponibles. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qué cuenta está destinada a usarse junto con el modelo de seguridad de Azure AD. Representa un ID único para la cuenta de Azure Maps y puede recuperarse desde la API de cuentas de Azure Maps Management Plane. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Idioma en el que se deben devolver los resultados de la búsqueda. Consulte idiomas admitidos para obtener más información. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Una respuesta de error inesperada. Media Types: "application/geo+json", "application/json" Encabezados x-ms-error-code: string |
Seguridad
AadToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.
Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Note
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-idpara indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
- El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.
Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.
Tipo:
apiKey
En:
header
SAS Token
Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Get polygon for a city at coordinates -122.204141,47.612560
Solicitud de ejemplo
GET https://atlas.microsoft.com/search/polygon?api-version=2026-01-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
Respuesta de muestra
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"
}
]
}
}Definiciones
| Nombre | Description |
|---|---|
|
Azure. |
Objeto de error. |
|
Azure. |
Respuesta que contiene los detalles del error. |
|
Azure. |
Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
| Boundary |
El cuerpo de respuesta exitosa devuelto por |
|
Boundary |
La |
|
Boundary |
El nivel de jerarquía geográfica solicitado al llamar |
|
Feature |
El |
|
Geo |
Tipo de objeto |
|
Geo |
Un tipo de geometría |
|
Geo |
Un tipo de geometría |
|
Geo |
Un tipo de geometría |
|
Geo |
Tipo de objeto |
|
Geo |
Especifica el tipo de |
|
Geo |
Un tipo de geometría |
|
Geo |
Un tipo de geometría |
|
Geometry |
Una única entrada de atribución por proveedor de datos de geometría dentro |
|
Resolution |
El nivel de detalle utilizado para el |
Azure.Core.Foundations.Error
Objeto de error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
| message |
string |
Representación legible del error. |
| target |
string |
Destino del error. |
Azure.Core.Foundations.ErrorResponse
Respuesta que contiene los detalles del error.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
Azure.Core.Foundations.InnerError
Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| innererror |
Error interno. |
Boundary
El cuerpo de respuesta exitosa devuelto por Get Polygon. Codificado como un GeoJSON Feature cuyo geometry es un GeometryCollection de una o más MultiPolygonPolygon formas que describen el contorno del área geográfica solicitada, y que properties llevan el nombre de visualización y la atribución de derechos de autor del área.
| Nombre | Tipo | Description |
|---|---|---|
| geometry |
A de una o más |
|
| properties |
Nombre de visualización y atribución de derechos de autor para el área devuelta. Consulta |
|
| type |
El tipo de |
BoundaryProperties
La properties carga útil de un Boundary. Lleva el nombre de visualización del área geográfica devuelto junto con la atribución de derechos de autor, tanto un aviso a nivel API como créditos por proveedor de datos geométricos.
| Nombre | Tipo | Description |
|---|---|---|
| copyright |
string |
El aviso de copyright y uso de la API de Azure Maps que se aplica a esta respuesta. Distinto de las atribuciones de proveedor de datos por geometría en |
| copyrightUrl |
string |
Una URL a la información de derechos de autor y licencias de Azure Maps para la API y sus fuentes de datos subyacentes. |
| geometriesCopyright |
Atribución por proveedor de datos geométrico. Cada entrada corresponde posicionalmente a la forma correspondiente en el array padre |
|
| name |
string |
El nombre de visualización del área geográfica, por ejemplo, |
BoundaryResultTypeEnum
El nivel de jerarquía geográfica solicitado al llamar Get Polygona . El valor se proporciona como resultType parámetro de consulta y selecciona qué nivel de la jerarquía administrativa o postal delinea el polígono devuelto Boundary . El valor predeterminado es countryRegion cuando no se especifica.
| Valor | Description |
|---|---|
| countryRegion |
Un país o región. |
| adminDistrict |
Primer nivel administrativo dentro del país o región, como un estado o una provincia. |
| adminDistrict2 |
Segundo nivel administrativo dentro del país/región, como un condado. |
| postalCode |
La categoría de código postal más pequeña, como un código postal. |
| postalCode2 |
La siguiente categoría de código postal más grande después |
| postalCode3 |
La siguiente categoría de código postal más grande después |
| postalCode4 |
La siguiente categoría de código postal más grande después |
| neighborhood |
Un área reconocida localmente dentro de un lugar poblado, a menudo con límites informales o culturalmente definidos. |
| locality |
Un área concentrada de asentamiento humano, como una ciudad, pueblo o aldea. |
FeatureTypeEnum
El GeoJSON tipo de objeto para Feature los objetos. Etiqueta cada entrada dentro del features array de una FeatureCollection respuesta (geocodificación, geocodificación inversa, autocompletado) y aparece en la raíz de la Get Polygon respuesta. El único valor es Feature, según se define en el RFC 7946.
| Valor | Description |
|---|---|
| Feature |
El tipo de |
GeoJsonGeometryCollection
Tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obtener más información.
GeoJsonLineString
Un tipo de geometría GeoJSON LineString válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiLineString
Un tipo de geometría GeoJSON MultiLineString válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiPoint
Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.
GeoJsonMultiPolygon
Tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obtener más información.
GeoJsonObjectType
Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.
| Valor | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Objeto |
| FeatureCollection |
Objeto |
GeoJsonPoint
Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.
GeoJsonPolygon
Un tipo de geometría GeoJSON Polygon válido. Consulte RFC 7946 para obtener más información.
GeometryCopyright
Una única entrada de atribución por proveedor de datos de geometría dentro BoundaryProperties.geometriesCopyrightde . Identifica la fuente de una geometría en el array padre Boundary.geometry.geometries .
| Nombre | Tipo | Description |
|---|---|---|
| copyright |
string |
La cadena de atribución legible por humanos para el proveedor de datos. Por ejemplo: |
| sourceName |
string |
Un identificador del proveedor de datos que suministró esta geometría. |
ResolutionEnum
El nivel de detalle utilizado para el Boundary polígono devuelto por Get Polygon. Suministrado como parámetro de resolution consulta, el valor selecciona cuántos puntos delinean la frontera, en orden ascendente: small, medium, large, huge. Los niveles superiores usan el mismo número de puntos que el siguiente nivel inferior o más. El valor predeterminado es medium cuando no se especifica.
| Valor | Description |
|---|---|
| small |
Devuelve la geometría de frontera con menos puntos. |
| medium |
Devuelve la geometría de frontera con el mismo número de puntos que |
| large |
Devuelve la geometría de frontera con el mismo número de puntos que |
| huge |
Devuelve la geometría de frontera con el mismo número de puntos que |