Spatial - Post Buffer

Referencia

Servicio:: Maps

Versión de la API:: 2022-08-01

Use para obtener un FeatureCollection donde cada característica es un búfer alrededor de la característica indizada correspondiente de la entrada.

La Post Buffer API es una solicitud HTTP POST que devuelve un FeatureCollection donde cada característica es un búfer alrededor de la característica indizada correspondiente de la entrada. El búfer podría estar en el exterior o dentro de la característica proporcionada, dependiendo de la distancia proporcionada en la entrada. Debe haber una distancia proporcionada por característica en la FeatureCollection entrada, o si solo se proporciona una distancia, esa distancia se aplica a cada característica de la colección. El búfer positivo (o negativo) de una geometría se define como la suma minkowski (o diferencia) de la geometría con un círculo de radio igual al valor absoluto de la distancia del búfer. La API de búfer siempre devuelve un resultado poligonal. El búfer negativo o de distancia cero de líneas y puntos siempre es un polígono vacío. La entrada puede contener una colección de Point, MultiPoint, Polygon, MultiPolygon, LineString y MultiLineString. GeometryCollection se omitirá si se proporciona.

POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01

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`.
geography	path	True	string	Ubicación de la cuenta de Azure Maps. Los valores válidos son nosotros (Este de EE. UU., Centro-oeste de EE. UU., Oeste de EE. UU. 2) y eu (Norte de Europa, Oeste de Europa). Este parámetro es necesario cuando se proporciona un `udid` elemento en la solicitud. Por ejemplo, si la cuenta de Azure Maps se encuentra en este de EE. UU., solo se aceptarán las solicitudes a la geografía.
api-version	query	True	string	Número de versión de la API de Azure Maps.

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 Id. de Entra de Microsoft. 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 id. de Entra de Microsoft en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Cuerpo de la solicitud

Nombre	Tipo	Description
distances	number[]	Lista de las distancias para calcular el búfer para, uno a uno por característica de la colección, o uno para todas las características de la colección.
geometries	GeoJsonFeatureCollection	Tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obtener más información.

Respuestas

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

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , 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 mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los 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.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado 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.

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 mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las 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 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 un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las 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.

En el caso de 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 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, la CLI, los SDK de Azure o las 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

PostBuffer

Solicitud de ejemplo

HTTP

POST https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01

{
  "geometries": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "geometryId": "ExampleId"
        },
        "geometry": {
          "type": "Point",
          "coordinates": [
            -111.9267386,
            33.5362475
          ]
        }
      }
    ]
  },
  "distances": [
    176.3
  ]
}

Respuesta de muestra

status code:: 200

{
  "summary": {
    "udid": null,
    "information": "1 feature processed in user data"
  },
  "result": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "geometryId": "ExampleId",
          "bufferDist": 176.3
        },
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -111.92483859605078,
                33.5362475
              ],
              [
                -111.92487510409389,
                33.53587682761772
              ],
              [
                -111.92498322523961,
                33.535520399967204
              ],
              [
                -111.92515880445296,
                33.535191914363196
              ],
              [
                -111.92539509432322,
                33.53490399432323
              ],
              [
                -111.92568301436319,
                33.53466770445297
              ],
              [
                -111.9260114999672,
                33.53449212523963
              ],
              [
                -111.9263679276177,
                33.5343840040939
              ],
              [
                -111.9267386,
                33.534347496050785
              ],
              [
                -111.92710927238228,
                33.5343840040939
              ],
              [
                -111.92746570003278,
                33.53449212523963
              ],
              [
                -111.9277941856368,
                33.53466770445297
              ],
              [
                -111.92808210567676,
                33.53490399432323
              ],
              [
                -111.92831839554702,
                33.535191914363196
              ],
              [
                -111.92849397476037,
                33.535520399967204
              ],
              [
                -111.9286020959061,
                33.53587682761772
              ],
              [
                -111.92863860394921,
                33.5362475
              ],
              [
                -111.9286020959061,
                33.53661817238228
              ],
              [
                -111.92849397476037,
                33.5369746000328
              ],
              [
                -111.92831839554702,
                33.53730308563681
              ],
              [
                -111.92808210567676,
                33.537591005676774
              ],
              [
                -111.9277941856368,
                33.53782729554703
              ],
              [
                -111.92746570003278,
                33.53800287476037
              ],
              [
                -111.92710927238228,
                33.5381109959061
              ],
              [
                -111.9267386,
                33.53814750394922
              ],
              [
                -111.9263679276177,
                33.5381109959061
              ],
              [
                -111.9260114999672,
                33.53800287476037
              ],
              [
                -111.92568301436319,
                33.53782729554703
              ],
              [
                -111.92539509432322,
                33.537591005676774
              ],
              [
                -111.92515880445296,
                33.53730308563681
              ],
              [
                -111.92498322523961,
                33.5369746000328
              ],
              [
                -111.92487510409389,
                33.53661817238228
              ],
              [
                -111.92483859605078,
                33.5362475
              ]
            ]
          ]
        }
      }
    ]
  }
}

Definiciones

Nombre	Description
BufferRequestBody	Objeto con featureCollection y una lista de distancias. Todas las propiedades de la característica deben contener `geometryId`, que se usa para identificar la geometría y distingue mayúsculas de minúsculas.
BufferResult	Este objeto se devuelve de una llamada correcta al búfer espacial.
BufferSummary
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`.

BufferRequestBody

Objeto con featureCollection y una lista de distancias. Todas las propiedades de la característica deben contener geometryId, que se usa para identificar la geometría y distingue mayúsculas de minúsculas.

Nombre	Tipo	Description
distances	number[]	Lista de las distancias para calcular el búfer para, uno a uno por característica de la colección, o uno para todas las características de la colección.
geometries	GeoJsonFeatureCollection	Tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obtener más información.

BufferResult

Este objeto se devuelve de una llamada correcta al búfer espacial.

Nombre	Tipo	Description
result	GeoJsonFeatureCollection	FeatureCollection de búferes para la entrada.
summary	BufferSummary

BufferSummary

Nombre	Tipo	Description
information	string	Información sobre lo que sucedió durante la llamada.
udid	string	El udid para los datos de usuario si existe uno

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 objeto 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 objeto 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 objeto 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 x, y order (longitud, latitud).
type	string: GeometryCollection	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objeto 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 objeto 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 objeto 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 objeto 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 x, y order (longitud, latitud).
type	string: MultiPolygon	Especifica el tipo `GeoJSON`. Debe ser uno de los nueve tipos de objeto 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[]	Un `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 objeto 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 objeto 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

Compartir a través de