Spatial - Get Buffer

Referencia

Service:: Maps

API Version:: 2022-08-01

A használatával lekérheti, FeatureCollection hogy az egyes funkciók hol vannak pufferként a bemenet megfelelő indexelt funkciója körül.

Az Get Buffer API egy HTTP-kérés GET , amely egy FeatureCollection olyan értéket ad vissza, ahol az egyes funkciók pufferként jelennek meg a bemenet megfelelő indexelt funkciója körül. A puffer a bemenetben megadott távolságtól függően a megadott funkció külső vagy belső részén is lehet. A FeatureCollection bemenetben szolgáltatásonként egy távolságnak kell lennie, vagy ha csak egy távolság van megadva, akkor a rendszer ezt a távolságot alkalmazza a gyűjtemény minden funkciójára. A geometria pozitív (vagy negatív) puffere a geometria Minkowski-összege (vagy különbsége), amelynek sugara megegyezik a puffer távolságának abszolút értékével. A puffer API mindig sokszög eredményt ad vissza. A vonalak és pontok negatív vagy nulla távolságú puffere mindig üres sokszög. A bemeneti funkciókat egy GeoJSON-fájl biztosítja, amely a Data registry API használatával tölthető fel, és egy egyedi udid hivatkozik gombra. A GeoJSON-fájl tartalmazhat Point, MultiPoint, Polygon, MultiPolygon, LineString és MultiLineString gyűjteményt. A GeometryCollection függvény figyelmen kívül lesz hagyva, ha meg van adva.

Az API teszteléséhez feltöltheti a mintaadatokat a Post Buffer API-példákból (kérelemtörzs távolságok tömbje nélkül) az Adatregisztrációs adatbázis szolgáltatással, és lecserélheti a {udid} következő mintakérésben szereplő adatokat az udid adatregisztrációs adatbázis létrehozásakor használtra. További információ: Adatregisztrációs adatbázis létrehozása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
format	path	True	JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.
geography	path	True	string	A Azure Maps-fiók helye. Az érvényes értékek az USA keleti régiója, az USA nyugati középső régiója, az USA 2. nyugati régiója és az EU (Észak-Európa, Nyugat-Európa). Erre a paraméterre akkor van szükség, ha `udid` egy meg van adva a kérelemben. Ha például a Azure Maps-fiók az USA keleti régiójában található, csak a földrajzi hely felé irányuló kéréseket fogadja el a rendszer.
api-version	query	True	string	Azure Maps API verziószáma.
distances	query	True	string	A távolságok listája (egy funkciónként vagy egy az összes funkcióhoz), pontosvesszővel elválasztva. Például: 12.34;-56.78. A pozitív távolság a funkción kívüli puffert hoz létre, míg a negatív távolság puffert hoz létre a szolgáltatáson belül. Ha a negatív távolság nagyobb, mint maga a geometria, a függvény üres sokszöget ad vissza.
udid	query	True	string	Az érvényes GeoJSON FeatureCollection objektum feltöltéséhez használt egyedi azonosító, amely egy adatjegyzék létrehozásakor használatos. A részleteket az RFC 7946-os verziójában találja. A funkció minden tulajdonságának tartalmaznia kell a `geometryId`elemet, amely a geometria azonosítására szolgál, és megkülönbözteti a kis- és nagybetűk megkülönböztetését. Az adatregisztrációs adatbázis szolgáltatásával kapcsolatos további információkért lásd: Adatregisztrációs adatbázis létrehozása.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-id		string	Meghatározza, hogy melyik fiók legyen használatban a Microsoft Entra ID biztonsági modellel együtt. A Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeleti sík fiók API-jából. A biztonsági Microsoft Entra ID Azure Maps az alábbi cikkekben talál útmutatást.

Válaszok

Name	Típus	Description
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	Váratlan hiba történt.

Biztonság

AADToken

Ezek az OAuth 2.0-folyamatok Microsoft Entra. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintés.

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

Ez egy megosztott kulcs, amely akkor van kiépítve, amikor Azure Maps erőforrást hoz létre az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ezek jelenleg főkulcsként kezelhetők ahhoz a fiókhoz, amelyhez ki vannak adva.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy olyan Azure Maps REST API-k kiszolgálóról kiszolgálóra történő hozzáférését használja, ahol ez a kulcs biztonságosan tárolható.

Type: apiKey
In: header

SAS Token

Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.

Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.

Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.

Type: apiKey
In: header

Példák

GetBuffer

Sample Request

HTTP

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

Sample Response

Status code:: 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
              ]
            ]
          ]
        }
      }
    ]
  }
}

Definíciók

Name	Description
BufferResult	Ezt az objektumot egy sikeres térbeli pufferhívás adja vissza.
BufferSummary
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
GeoJsonFeature	Érvényes `GeoJSON Feature` objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonGeometry	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonGeometryCollection	Érvényes `GeoJSON GeometryCollection` objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonLineString	Érvényes `GeoJSON LineString` geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiLineString	Érvényes `GeoJSON MultiLineString` geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiPoint	Érvényes `GeoJSON MultiPoint` geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonMultiPolygon	Érvényes `GeoJSON MultiPolygon` objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonPoint	Érvényes `GeoJSON Point` geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
GeoJsonPolygon	Érvényes `GeoJSON Polygon` geometriatípus. A részletekért tekintse meg az RFC 7946-ot .
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.

BufferResult

Ezt az objektumot egy sikeres térbeli pufferhívás adja vissza.

Name	Típus	Description
result	GeoJsonFeatureCollection	A bemenet puffereinek FeatureCollection tulajdonsága.
summary	BufferSummary

BufferSummary

Name	Típus	Description
information	string	Az információ arról, hogy mi történt a hívás során.
udid	string	A felhasználói adatok udid értéke, ha van ilyen

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GeoJsonFeature

Érvényes GeoJSON Feature objektumtípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
featureType	string	A szolgáltatás típusa. Az érték attól függ, hogy az aktuális funkció melyik adatmodell része. Egyes adatmodellek üres értékkel rendelkezhetnek.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részletekért tekintse meg az RFC 7946-ot .
id	string	A funkció azonosítója.
type	string: Feature	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonFeatureCollection

Érvényes GeoJSON FeatureCollection objektumtípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
features	GeoJsonFeature[]	Az érvényes `GeoJSON Feature` objektumok listáját tartalmazza.
type	string: FeatureCollection	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometry

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Pont, MultiPoint, Vonallánc, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
type	GeoJsonObjectType	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometryCollection

Érvényes GeoJSON GeometryCollection objektumtípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Érvényes geometriai objektumok listáját `GeoJSON` tartalmazza. Vegye figyelembe , hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: GeometryCollection	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonLineString

Érvényes GeoJSON LineString geometriatípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson LineString` .
type	string: LineString	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiLineString

Érvényes GeoJSON MultiLineString geometriatípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson MultiLineString` .
type	string: MultiLineString	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPoint

Érvényes GeoJSON MultiPoint geometriatípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	A geometria koordinátái `GeoJson MultiPoint` .
type	string: MultiPoint	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPolygon

Érvényes GeoJSON MultiPolygon objektumtípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	Az érvényes `GeoJSON Polygon` objektumok listáját tartalmazza. Vegye figyelembe , hogy a GeoJSON koordinátái x, y sorrendben vannak (hosszúság, szélesség).
type	string: MultiPolygon	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPoint

Érvényes GeoJSON Point geometriatípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	Az A `Position` két vagy több elemet tartalmazó számok tömbje. Az első két elem a hosszúság és a szélesség, pontosan ebben a sorrendben. A magasság/magasság opcionális harmadik elem. A részletekért tekintse meg az RFC 7946-ot .
type	string: Point	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPolygon

Érvényes GeoJSON Polygon geometriatípus. A részletekért tekintse meg az RFC 7946-ot .

Name	Típus	Description
coordinates	number[]	A geometriatípus koordinátái `GeoJson Polygon` .
type	string: Polygon	Megadja a típust `GeoJSON` . A kilenc érvényes GeoJSON-objektumtípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

JsonFormat

A válasz kívánt formátuma. Csak json a formátum támogatott.

Name	Típus	Description
json	string	A JavaScript-objektum jelölési adatcseréjének formátuma