Spatial - Post Buffer
Use para obter um FeatureCollection em que cada recurso é um buffer em torno do recurso indexado correspondente da entrada.
A Post Buffer API é uma solicitação HTTP POST que retorna um FeatureCollection em que cada recurso é um buffer em torno do recurso indexado correspondente da entrada. O buffer pode estar no lado de fora ou no interior do recurso fornecido, dependendo da distância fornecida na entrada. Deve haver uma distância fornecida por Feature na FeatureCollection entrada ou, se apenas uma distância for fornecida, essa distância será aplicada a todos os recursos da coleção. O buffer positivo (ou negativo) de uma geometria é definido como a soma minkowski (ou diferença) da geometria com um círculo de raio igual ao valor absoluto da distância do buffer. A API do buffer sempre retorna um resultado poligonal. O buffer negativo 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 fornecido.
POST https://{geography}.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
format
|
path | True |
Formato desejado da resposta. Há suporte apenas para o formato |
|
|
geography
|
path | True |
string |
Local da conta do Azure Mapas. Os valores válidos são nós (Leste dos EUA, Centro-Oeste dos EUA, Oeste dos EUA 2) e UE (Norte da Europa, Europa Ocidental). Esse parâmetro é necessário quando um |
|
api-version
|
query | True |
string |
Número de versão da API de Mapas Azure. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes. |
Corpo da solicitação
| Nome | Tipo | Description |
|---|---|---|
| distances |
number[] |
Lista das distâncias para calcular o buffer, um para um por Recurso na coleção ou um para todos os Recursos na coleção. |
| geometries |
Um tipo de objeto válido |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Erro inesperado. |
Segurança
AADToken
Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-idcabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações de Microsoft Entra ID.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre plataforma de identidade da Microsoft, consulte visão geral plataforma de identidade da Microsoft.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um recurso de Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como master chaves para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor de Azure Mapas APIs REST em que essa chave pode ser armazenada com segurança.
Type:
apiKey
In:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para a expiração, a taxa e as regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.
Type:
apiKey
In:
header
Exemplos
PostBuffer
Sample Request
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
{
"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
| Nome | Description |
|---|---|
|
Buffer |
Um objeto com um FeatureCollection e uma lista de distâncias. Todas as propriedades do recurso devem conter |
|
Buffer |
Esse objeto é retornado de uma chamada de Buffer Espacial bem-sucedida. |
|
Buffer |
|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
Os detalhes do erro. |
|
Error |
Resposta de erro |
|
Geo |
Um tipo de objeto válido |
|
Geo |
Um tipo de objeto válido |
|
Geo |
Um objeto de geometria válido |
|
Geo |
Um tipo de objeto válido |
|
Geo |
Um tipo de geometria válido |
|
Geo |
Um tipo de geometria válido |
|
Geo |
Um tipo de geometria válido |
|
Geo |
Um tipo de objeto válido |
|
Geo |
Um tipo de geometria válido |
|
Geo |
Um tipo de geometria válido |
|
Json |
Formato desejado da resposta. Há suporte apenas para o formato |
BufferRequestBody
Um objeto com um FeatureCollection e uma lista de distâncias. Todas as propriedades do recurso devem conter geometryId, que é usado para identificar a geometria e diferencia maiúsculas de minúsculas.
| Nome | Tipo | Description |
|---|---|---|
| distances |
number[] |
Lista das distâncias para calcular o buffer, um para um por Recurso na coleção ou um para todos os Recursos na coleção. |
| geometries |
Um tipo de objeto válido |
BufferResult
Esse objeto é retornado de uma chamada de Buffer Espacial bem-sucedida.
| Nome | Tipo | Description |
|---|---|---|
| result |
O FeatureCollection de buffers para a entrada. |
|
| summary |
BufferSummary
| Nome | Tipo | Description |
|---|---|---|
| information |
string |
As informações sobre o que aconteceu durante a chamada. |
| udid |
string |
O udid para os dados do usuário, se houver |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
Os detalhes do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
GeoJsonFeature
Um tipo de objeto válido GeoJSON Feature . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| featureType |
string |
O tipo do recurso. O valor depende do modelo de dados do qual o recurso atual faz parte. Alguns modelos de dados podem ter um valor vazio. |
| geometry | GeoJsonGeometry: |
Um objeto de geometria válido |
| id |
string |
Identificador do recurso. |
| type |
string:
Feature |
Especifica o tipo de |
GeoJsonFeatureCollection
Um tipo de objeto válido GeoJSON FeatureCollection . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| features |
Contém uma lista de objetos válidos |
|
| type |
string:
Feature |
Especifica o tipo de |
GeoJsonGeometry
Um objeto de geometria válido GeoJSON . O tipo deve ser um dos sete tipos de geometria GeoJSON válidos : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| type |
Geo |
Especifica o tipo de |
GeoJsonGeometryCollection
Um tipo de objeto válido GeoJSON GeometryCollection . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| geometries | GeoJsonGeometry[]: |
Contém uma lista de objetos de geometria válidos |
| type |
string:
Geometry |
Especifica o tipo de |
GeoJsonLineString
Um tipo de geometria válido GeoJSON LineString . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Line |
Especifica o tipo de |
GeoJsonMultiLineString
Um tipo de geometria válido GeoJSON MultiLineString . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonMultiPoint
Um tipo de geometria válido GeoJSON MultiPoint . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para a |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonMultiPolygon
Um tipo de objeto válido GeoJSON MultiPolygon . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Contém uma lista de objetos válidos |
| type |
string:
Multi |
Especifica o tipo de |
GeoJsonPoint
Um tipo de geometria válido GeoJSON Point . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Um |
| type |
string:
Point |
Especifica o tipo de |
GeoJsonPolygon
Um tipo de geometria válido GeoJSON Polygon . Consulte RFC 7946 para obter detalhes.
| Nome | Tipo | Description |
|---|---|---|
| coordinates |
number[] |
Coordenadas para o |
| type |
string:
Polygon |
Especifica o tipo de |
JsonFormat
Formato desejado da resposta. Há suporte apenas para o formato json.
| Nome | Tipo | Description |
|---|---|---|
| json |
string |
O formato de intercâmbio de dados de notação de objeto JavaScript |