Search - Get Search 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 devuelve datos de geometría, como un esquema de ciudad o país o región para un conjunto de entidades, recuperado previamente de una solicitud de búsqueda en línea en formato GeoJSON. El identificador de geometría se devuelve en el objeto sourceGeometry
en "geometry" y "id" en una llamada de dirección de búsqueda o búsqueda aproximada.
Un identificador de geometría recuperado de un punto de conexión de búsqueda en línea tiene una duración limitada, no se recomienda almacenar identificadores de geometría en el almacenamiento persistente para la referencia posterior. Se espera que se realice una solicitud al método Polygon en unos minutos después de la solicitud al método de búsqueda en línea que proporcionó el identificador. El servicio permite solicitudes por lotes de hasta 20 identificadores.
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries={geometries}
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
format
|
path | True |
Formato deseado de la respuesta. Solo se admite |
|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
geometries
|
query | True |
string[] |
Lista separada por comas de UUID de geometría, recuperados previamente de una solicitud de búsqueda en línea. |
Encabezado de la solicitud
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
De acuerdo |
|
Other Status Codes |
Se ha producido un error inesperado. |
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 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 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:
query
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 the Geometry using the geometry id returned by the previous Search
Solicitud de ejemplo
GET https://atlas.microsoft.com/search/polygon/json?api-version=1.0&geometries=8bceafe8-3d98-4445-b29b-fd81d3e9adf5,00005858-5800-1200-0000-0000773694ca
Respuesta de muestra
{
"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"
}
]
}
}
]
}
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Geo |
Tipo de objeto |
Geo |
Tipo de objeto |
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 |
Json |
Formato deseado de la respuesta. Solo se admite |
Polygon | |
Polygon |
Este objeto se devuelve de una llamada a Polygon de búsqueda correcta. |
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. |
GeoJsonFeature
Tipo de objeto GeoJSON Feature
válido. Consulte RFC 7946 para obtener más información.
GeoJsonFeatureCollection
Tipo de objeto GeoJSON FeatureCollection
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
features |
Contiene una lista de objetos |
|
type |
string:
Feature |
Especifica el tipo de |
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.
Nombre | Tipo | Description |
---|---|---|
type |
Geo |
Especifica el tipo de |
GeoJsonGeometryCollection
Tipo de objeto GeoJSON GeometryCollection
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Contiene una lista de objetos de geometría de |
type |
string:
Geometry |
Especifica el tipo de |
GeoJsonLineString
Un tipo de geometría GeoJSON LineString
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] (double) |
Coordenadas de la geometría |
type |
string:
Line |
Especifica el tipo de |
GeoJsonMultiLineString
Un tipo de geometría GeoJSON MultiLineString
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] (double) |
Coordenadas de la geometría |
type |
string:
Multi |
Especifica el tipo de |
GeoJsonMultiPoint
Un tipo de geometría GeoJSON MultiPoint
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] (double) |
Coordenadas de la geometría |
type |
string:
Multi |
Especifica el tipo de |
GeoJsonMultiPolygon
Tipo de objeto GeoJSON MultiPolygon
válido. Consulte RFC 7946 para obtener más información.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] (double) |
Contiene una lista de objetos |
type |
string:
Multi |
Especifica el tipo de |
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.
Nombre | Tipo | Description |
---|---|---|
coordinates |
number[] (double) |
Coordenadas del tipo de geometría |
type | string: |
Especifica el tipo de |
JsonFormat
Formato deseado de la respuesta. Solo se admite json
formato.
Valor | Description |
---|---|
json |
el formato de intercambio de datos de notación de objetos JavaScript |
Polygon
PolygonResult
Este objeto se devuelve de una llamada a Polygon de búsqueda correcta.
Nombre | Tipo | Description |
---|---|---|
additionalData |
Polygon[] |
Matriz de resultados |