Spatial - Post Buffer

Referência

Service:: Maps

API Version:: 2022-08-01

Utilize para obter uma FeatureCollection localização em que cada funcionalidade é uma memória intermédia em torno da funcionalidade indexada correspondente da entrada.

A Post Buffer API é um pedido HTTP POST que devolve um FeatureCollection em que cada funcionalidade é uma memória intermédia em torno da funcionalidade indexada correspondente da entrada. A memória intermédia pode estar no exterior ou no interior da funcionalidade fornecida, consoante a distância fornecida na entrada. Tem de existir uma distância fornecida por Funcionalidade na FeatureCollection entrada ou, se for fornecida apenas uma distância, essa distância é aplicada a todas as funcionalidades da coleção. A memória intermédia positiva (ou negativa) de uma geometria é definida como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância da memória intermédia. A API de memória intermédia devolve sempre um resultado poligonal. A memória intermédia negativa ou de distância zero de linhas e pontos é sempre um polígono vazio. A entrada pode conter uma coleção de Point, MultiPoint, Polygon, MultiPolygon, LineString e MultiLineString. GeometryCollection será ignorado se for fornecido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
geography	path	True	string	Localização da Conta Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental). Este parâmetro é necessário quando um `udid` é fornecido no pedido. Por exemplo, se a Conta de Azure Maps estiver localizada na região E.U.A. Leste, apenas serão aceites pedidos de geografia.
api-version	query	True	string	Número da versão da API Azure Maps.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-id		string	Especifica a conta que se destina à utilização em conjunto com o modelo de segurança Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Corpo do Pedido

Name	Tipo	Description
distances	number[]	Lista das distâncias para calcular a memória intermédia, um-para-um por Funcionalidade na coleção ou uma para todas as Funcionalidades da coleção.
geometries	GeoJsonFeatureCollection	Um tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obter detalhes.

Respostas

Name	Tipo	Description
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

Segurança

AADToken

Estes são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que recurso Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações de Microsoft Entra ID. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Para obter mais informações sobre plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.

Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.

Type: apiKey
In: header

Exemplos

PostBuffer

Sample Request

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

Sample Response

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

Definições

Name	Description
BufferRequestBody	Um objeto com uma FeatureCollection e uma lista de distâncias. Todas as propriedades da funcionalidade devem conter `geometryId`, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.
BufferResult	Este objeto é devolvido de uma chamada de Memória Intermédia Espacial bem-sucedida.
BufferSummary
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
GeoJsonFeature	Um tipo de objeto válido `GeoJSON Feature` . Consulte RFC 7946 para obter detalhes.
GeoJsonFeatureCollection	Um tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obter detalhes.
GeoJsonGeometry	Um objeto de geometria válido `GeoJSON` . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
GeoJsonGeometryCollection	Um tipo de objeto válido `GeoJSON GeometryCollection` . Consulte RFC 7946 para obter detalhes.
GeoJsonLineString	Um tipo de geometria válido `GeoJSON LineString` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiLineString	Um tipo de geometria válido `GeoJSON MultiLineString` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPoint	Um tipo de geometria válido `GeoJSON MultiPoint` . Consulte RFC 7946 para obter detalhes.
GeoJsonMultiPolygon	Um tipo de objeto válido `GeoJSON MultiPolygon` . Consulte RFC 7946 para obter detalhes.
GeoJsonPoint	Um tipo de geometria válido `GeoJSON Point` . Consulte RFC 7946 para obter detalhes.
GeoJsonPolygon	Um tipo de geometria válido `GeoJSON Polygon` . Consulte RFC 7946 para obter detalhes.
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.

BufferRequestBody

Um objeto com uma FeatureCollection e uma lista de distâncias. Todas as propriedades da funcionalidade devem conter geometryId, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas.

Name	Tipo	Description
distances	number[]	Lista das distâncias para calcular a memória intermédia, um-para-um por Funcionalidade na coleção ou uma para todas as Funcionalidades da coleção.
geometries	GeoJsonFeatureCollection	Um tipo de objeto válido `GeoJSON FeatureCollection` . Consulte RFC 7946 para obter detalhes.

BufferResult

Este objeto é devolvido de uma chamada de Memória Intermédia Espacial bem-sucedida.

Name	Tipo	Description
result	GeoJsonFeatureCollection	O FeatureCollection das memórias intermédias para a entrada.
summary	BufferSummary

BufferSummary

Name	Tipo	Description
information	string	As informações sobre o que aconteceu durante a chamada.
udid	string	O udid para os dados do utilizador, se existir

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeoJsonFeature

Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
featureType	string	O tipo da funcionalidade. O valor depende do modelo de dados do qual a funcionalidade atual faz parte. Alguns modelos de dados podem ter um valor vazio.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Um objeto de geometria válido `GeoJSON` . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
id	string	Identificador da funcionalidade.
type	string: Feature	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonFeatureCollection

Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
features	GeoJsonFeature[]	Contém uma lista de objetos válidos `GeoJSON Feature` .
type	string: FeatureCollection	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometry

Um objeto de geometria válido GeoJSON . O tipo tem de ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
type	GeoJsonObjectType	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contém uma lista de objetos de geometria válidos `GeoJSON` . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: GeometryCollection	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson LineString` geometria.
type	string: LineString	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson MultiLineString` geometria.
type	string: MultiLineString	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para a `GeoJson MultiPoint` geometria.
type	string: MultiPoint	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Contém uma lista de objetos válidos `GeoJSON Polygon` . Tenha em atenção que as coordenadas em GeoJSON estão por ordem x, y (longitude, latitude).
type	string: MultiPolygon	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	A `Position` é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são longitude e latitude, precisamente por essa ordem. Altitude/Elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.
type	string: Point	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.

Name	Tipo	Description
coordinates	number[]	Coordenadas para o `GeoJson Polygon` tipo de geometria.
type	string: Polygon	Especifica o `GeoJSON` tipo. Tem de ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange