Search - Get Search Polygon

Referencia

Servicio:: Maps

Versión de la API:: 1.0

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 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 sourceGeometry objeto bajo "geometry" y "id" en una dirección de Búsqueda o Búsqueda llamada 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 los 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 a partir 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	JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
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, recuperadas previamente de una solicitud de búsqueda en línea.

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 Microsoft Entra ID. 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 Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	PolygonResult	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth 2.0 de Microsoft Entra. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de 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 x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps .
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 Microsoft Entra ID.
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, CLI, SDK de Azure o API REST.
El uso del 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 Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

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 cuenta de Azure Maps en el 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.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea 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 está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos 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

HTTP

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

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"
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeoJsonFeature	Tipo de objeto válido `GeoJSON Feature` . Consulte RFC 7946 para obtener más información.
GeoJsonFeatureCollection	Tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obtener más información.
GeoJsonGeometry	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 válido `GeoJSON GeometryCollection` . Consulte RFC 7946 para obtener más información.
GeoJsonLineString	Un tipo de geometría válido `GeoJSON LineString` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiLineString	Un tipo de geometría válido `GeoJSON MultiLineString` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPoint	Un tipo de geometría válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obtener más información.
GeoJsonMultiPolygon	Tipo de objeto válido `GeoJSON MultiPolygon` . Consulte RFC 7946 para obtener más información.
GeoJsonPoint	Un tipo de geometría válido `GeoJSON Point` . Consulte RFC 7946 para obtener más información.
GeoJsonPolygon	Un tipo de geometría válido `GeoJSON Polygon` . Consulte RFC 7946 para obtener más información.
JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
Polygon
PolygonResult	Este objeto se devuelve de una llamada Búsqueda Polygon 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	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeoJsonFeature

Tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
featureType	string	Tipo de la característica. El valor depende del modelo de datos del que forma parte la característica actual. Algunos modelos de datos pueden tener un valor vacío.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	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.
id	string	Identificador de la característica.
type	string: Feature	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonFeatureCollection

Tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
features	GeoJsonFeature[]	Contiene una lista de objetos válidos `GeoJSON Feature` .
type	string: FeatureCollection	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometry

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	GeoJsonObjectType	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometryCollection

Tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contiene una lista de objetos geometry válidos `GeoJSON` . Tenga en cuenta que las coordenadas de GeoJSON están en orden x, y (longitud, latitud).
type	string: GeometryCollection	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonLineString

Un tipo de geometría válido GeoJSON LineString . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson LineString` geometría.
type	string: LineString	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiLineString

Un tipo de geometría válido GeoJSON MultiLineString . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson MultiLineString` geometría.
type	string: MultiLineString	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPoint

Un tipo de geometría válido GeoJSON MultiPoint . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas de la `GeoJson MultiPoint` geometría.
type	string: MultiPoint	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPolygon

Tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Contiene una lista de objetos válidos `GeoJSON Polygon` . Tenga en cuenta que las coordenadas de GeoJSON están en orden x, y (longitud, latitud).
type	string: MultiPolygon	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPoint

Un tipo de geometría válido GeoJSON Point . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	A `Position` es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. Altitud/Elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type	string: Point	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPolygon

Un tipo de geometría válido GeoJSON Polygon . Consulte RFC 7946 para obtener más información.

Nombre	Tipo	Description
coordinates	number[]	Coordenadas para el `GeoJson Polygon` tipo de geometría.
type	string: Polygon	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objetos GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript

Polygon

Nombre	Tipo	Description
geometryData	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	Datos de geometría en formato GeoJSON. Consulte RFC 7946 para obtener más información. Presente solo si "error" no está presente.
providerID	string	Identificador de la entidad devuelta

PolygonResult

Este objeto se devuelve de una llamada Búsqueda Polygon correcta.

Nombre	Tipo	Description
additionalData	Polygon[]	Matriz de resultados

Compartir a través de