Spatial - Get Buffer

Riferimento

Servizio:: Maps

Versione API:: 2022-08-01

Usare per ottenere un FeatureCollection oggetto in cui ogni funzionalità è un buffer intorno alla funzionalità indicizzata corrispondente dell'input.

L'API Get Buffer è una richiesta HTTP GET che restituisce un oggetto FeatureCollection in cui ogni funzionalità è un buffer intorno alla funzionalità indicizzata corrispondente dell'input. Il buffer può trovarsi all'esterno o all'interno della funzionalità specificata, a seconda della distanza specificata nell'input. Deve essere presente una distanza specificata per Ogni caratteristica nell'input FeatureCollection o, se viene specificata una sola distanza, tale distanza viene applicata a ogni caratteristica della raccolta. Il buffer positivo (o negativo) di una geometria è definito come somma minkowski (o differenza) della geometria con un cerchio di raggio uguale al valore assoluto della distanza del buffer. L'API buffer restituisce sempre un risultato poligono. Il buffer negativo o zero-distance di linee e punti è sempre un poligono vuoto. Le funzionalità di input vengono fornite da un file GeoJSON che viene caricato usando l'API del Registro di sistema dati e a cui fa riferimento un udid univoco. Il file GeoJSON può contenere una raccolta di Point, MultiPoint, Polygon, MultiPolygon, LineString e MultiLineString. GeometryCollection verrà ignorato se specificato.

Per testare questa API, è possibile caricare i dati di esempio dagli esempi dell'API Post Buffer (Corpo della richiesta senza distanze) usando il servizio Registro di sistema dati e sostituire nella {udid}richiesta di esempio seguente con l'oggetto udid usato durante la creazione del Registro di sistema dei dati. Per altre informazioni, vedere Come creare il Registro di sistema dei dati.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.
geography	path	True	string	Posizione dell'account mappe di Azure. I valori validi sono Stati Uniti orientali, Stati Uniti centro-occidentali, Stati Uniti occidentali 2 e eu (Europa settentrionale, Europa occidentale). Questo parametro è obbligatorio quando viene fornito un `udid` oggetto nella richiesta. Ad esempio, se l'account mappe di Azure si trova negli Stati Uniti orientali, verranno accettate solo le richieste all'area geografica.
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
distances	query	True	string	Elenco di distanze (una per caratteristica o una per tutte le funzionalità), delimitata da punto e virgola. Ad esempio, 12.34;-56.78. La distanza positiva genererà un buffer all'esterno della funzionalità, mentre la distanza negativa genererà un buffer all'interno della funzionalità. Se la distanza negativa è maggiore della geometria stessa, verrà restituito un poligono vuoto.
udid	query	True	string	ID univoco utilizzato durante la creazione di un registro dati per caricare un oggetto FeatureCollection GeoJSON valido. Per informazioni dettagliate, vedere RFC 7946 . Tutte le proprietà della funzionalità devono contenere `geometryId`, che viene usato per identificare la geometria e fa distinzione tra maiuscole e minuscole. Per altre informazioni sul servizio registro dati, vedere Come creare il Registro di sistema dei dati.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API del piano di gestione mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi di Microsoft Entra OAuth 2.0 . Quando è associato al controllo degli accessi in base al ruolo di Azure , può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più account delle risorse delle risorse di Mappe di Azure o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare la risorsa mappe di Azure a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di Microsoft Entra ID. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST. * L'utilizzo di Azure Maps Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Per altre informazioni su Microsoft Identity Platform, vedere Panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene eseguito il provisioning durante la creazione di una risorsa mappe di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, queste chiavi possono essere considerate come chiavi master per l'account per cui vengono rilasciate.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.

Tipo: apiKey
In: header

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione Elenca firma di accesso condiviso nella risorsa mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.

Con questo token, qualsiasi applicazione è autorizzata ad accedere con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.

Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa dell'account map per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.

Tipo: apiKey
In: header

Esempio

GetBuffer

Esempio di richiesta

HTTP

GET https://us.atlas.microsoft.com/spatial/buffer/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&distances=176.3

Risposta di esempio

Codice di stato:: 200

{
  "summary": {
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "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
              ]
            ]
          ]
        }
      }
    ]
  }
}

Definizioni

Nome	Descrizione
BufferResult	Questo oggetto viene restituito da una chiamata buffer spaziale riuscita.
BufferSummary
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GeoJsonFeature	Tipo di oggetto valido `GeoJSON Feature` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonFeatureCollection	Tipo di oggetto valido `GeoJSON FeatureCollection` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonGeometry	Oggetto geometry valido `GeoJSON` . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonGeometryCollection	Tipo di oggetto valido `GeoJSON GeometryCollection` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonLineString	Tipo geometry valido `GeoJSON LineString` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonMultiLineString	Tipo geometry valido `GeoJSON MultiLineString` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonMultiPoint	Tipo geometry valido `GeoJSON MultiPoint` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonMultiPolygon	Tipo di oggetto valido `GeoJSON MultiPolygon` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonPoint	Tipo geometry valido `GeoJSON Point` . Per informazioni dettagliate, vedere RFC 7946 .
GeoJsonPolygon	Tipo geometry valido `GeoJSON Polygon` . Per informazioni dettagliate, vedere RFC 7946 .
JsonFormat	Formato desiderato della risposta. È supportato solo il formato `json`.

BufferResult

Questo oggetto viene restituito da una chiamata buffer spaziale riuscita.

Nome	Tipo	Descrizione
result	GeoJsonFeatureCollection	FeatureCollection dei buffer per l'input.
summary	BufferSummary

BufferSummary

Nome	Tipo	Descrizione
information	string	Informazioni su ciò che è successo durante la chiamata.
udid	string	udid per i dati utente se esiste

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GeoJsonFeature

Tipo di oggetto valido GeoJSON Feature . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
featureType	string	Tipo di funzionalità. Il valore dipende dal modello di dati di cui fa parte la funzionalità corrente. Alcuni modelli di dati possono avere un valore vuoto.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Oggetto geometry valido `GeoJSON` . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .
id	string	Identificatore per la funzionalità.
type	string: Feature	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonFeatureCollection

Tipo di oggetto valido GeoJSON FeatureCollection . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
features	GeoJsonFeature[]	Contiene un elenco di oggetti validi `GeoJSON Feature` .
type	string: FeatureCollection	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometry

Oggetto geometry valido GeoJSON . Il tipo deve essere uno dei sette tipi di geometria GeoJSON validi- Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
type	GeoJsonObjectType	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Tipo di oggetto valido GeoJSON GeometryCollection . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Contiene un elenco di oggetti geometry validi `GeoJSON` . Si noti che le coordinate in GeoJSON sono in x, y ordine (longitudine, latitudine).
type	string: GeometryCollection	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Tipo geometry valido GeoJSON LineString . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Coordinate per la `GeoJson LineString` geometria.
type	string: LineString	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Tipo geometry valido GeoJSON MultiLineString . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Coordinate per la `GeoJson MultiLineString` geometria.
type	string: MultiLineString	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Tipo geometry valido GeoJSON MultiPoint . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Coordinate per la `GeoJson MultiPoint` geometria.
type	string: MultiPoint	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Tipo di oggetto valido GeoJSON MultiPolygon . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Contiene un elenco di oggetti validi `GeoJSON Polygon` . Si noti che le coordinate in GeoJSON sono in x, y ordine (longitudine, latitudine).
type	string: MultiPolygon	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Tipo geometry valido GeoJSON Point . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Una `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. Altitudine/Elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946 .
type	string: Point	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Tipo geometry valido GeoJSON Polygon . Per informazioni dettagliate, vedere RFC 7946 .

Nome	Tipo	Descrizione
coordinates	number[]	Coordinate per il `GeoJson Polygon` tipo geometry.
type	string: Polygon	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetti GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

JsonFormat

Formato desiderato della risposta. È supportato solo il formato json.

Nome	Tipo	Descrizione
json	string	Formato di interscambio dati dell'oggetto JavaScript

Condividi tramite