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 API de Get Polygon
es una solicitud http GET
que proporciona datos de polígono de un esquema de área geográfica, como una ciudad o una región de país.
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}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
coordinates
|
query | True |
number[] |
Punto de la tierra especificado como longitud y latitud. Ejemplo: &coordinates=lon,lat |
resolution
|
query |
La resolución determina la cantidad de puntos que se van a devolver. Si no se especifica, el valor predeterminado es la resolución media. |
||
result
|
query |
Concepto geopolítica para el que se va a devolver un límite. Si no se especifica, el valor predeterminado es |
||
view
|
query |
string |
Cadena que representa un código ISO 3166-1 Alpha-2 region/country. 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á pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de Azure AD en Azure Maps, consulte los siguientes artículos de para obtener instrucciones. |
|
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 |
De acuerdo Media Types: "application/geo+json" |
|
Other Status Codes |
Error inesperado. Media Types: "application/geo+json" |
Seguridad
AADToken
Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos 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.
Nota
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-id
para 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 URL
es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. - 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 | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear una 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 esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede 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=2023-06-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 |
---|---|
Boundary |
Tenga en cuenta que el servicio normalmente devuelve una clase GeometryCollection con subtipos Polygon o MultiPolygon. |
Boundary |
Propiedades de un objeto Boundary. |
Boundary |
Concepto geopolítica para el que se va a devolver un límite. Si no se especifica, el valor predeterminado es |
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Feature |
El tipo de una característica debe ser Característica. |
Geo |
Un objeto geometry válido |
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 |
Un tipo de geometría |
Geo |
Un tipo de geometría |
Geometry |
Información de copyright de una geometría de un objeto Boundary. |
Resolution |
La resolución determina la cantidad de puntos que se van a devolver. Si no se especifica, el valor predeterminado es la resolución media. |
Boundary
GeoJSON GeocodingFeature
objeto que describe los límites de un área geográfica. La geometría de la característica se describe con GeoJSON GeometryCollection
.
Tenga en cuenta que el servicio normalmente devuelve una clase GeometryCollection con subtipos Polygon o MultiPolygon.
BoundaryProperties
Propiedades de un objeto Boundary.
Nombre | Tipo | Description |
---|---|---|
copyright |
string |
Cadena de copyright. |
copyrightURL |
string |
Dirección URL que enumera muchos de los proveedores de datos de Azure Maps y su información relacionada con los derechos de autor. |
geometriesCopyright |
Colección de información de copyright para cada geometría del objeto Boundary en el mismo orden en que aparecen. |
|
name |
string |
Nombre asociado al área geográfica. |
BoundaryResultTypeEnum
Concepto geopolítica para el que se va a devolver un límite. Si no se especifica, el valor predeterminado es countryRegion
tipo de resultado.
Nombre | Tipo | Description |
---|---|---|
adminDistrict |
string |
Primer nivel administrativo dentro del nivel de país o región, como un estado o una provincia. |
adminDistrict2 |
string |
Segundo nivel administrativo dentro del nivel de país o región, como un condado. |
countryRegion |
string |
País o región. |
locality |
string |
Un área concentrada de asentamiento humano, como una ciudad, una ciudad o un pueblo. |
neighborhood |
string |
Sección de un lugar rellenado que suele ser conocido, pero a menudo con límites indistintos. |
postalCode |
string |
La categoría de código de publicación más pequeña, como un código postal. |
postalCode2 |
string |
La siguiente categoría de código postal más grande después de postalCode que se crea mediante la agregación de áreas postalCode. |
postalCode3 |
string |
La siguiente categoría de código postal más grande después de postalCode2 que se crea mediante la agregación de áreas postalCode2. |
postalCode4 |
string |
La siguiente categoría de código postal más grande después de postalCode3 que se crea mediante la agregación de áreas postalCode3. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
FeatureTypeEnum
El tipo de una característica debe ser Característica.
Nombre | Tipo | Description |
---|---|---|
Feature |
string |
GeoJsonGeometry
Un objeto geometry válido GeoJSON
. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.
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.
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
Información de copyright de una geometría de un objeto Boundary.
Nombre | Tipo | Description |
---|---|---|
copyright |
string |
Cadena de copyright para el proveedor de datos |
sourceName |
string |
Nombre del proveedor de datos |
ResolutionEnum
La resolución determina la cantidad de puntos que se van a devolver. Si no se especifica, el valor predeterminado es la resolución media.
Nombre | Tipo | Description |
---|---|---|
huge |
string |
Devuelve la geometría del límite con más o la misma cantidad de puntos que los grandes. |
large |
string |
Devuelve la geometría de límite con más o la misma cantidad de puntos que el medio. |
medium |
string |
Devuelve la geometría de límite con más o la misma cantidad de puntos que los pequeños. |
small |
string |
Devuelve la geometría del límite con la menor cantidad de puntos. |