Spatial - Post 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 Post Buffer API egy HTTP-kérés POST , 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 lehet a megadott funkció külső vagy belső része, a bemenetben megadott távolságtól függően. A bemenetben FeatureCollection 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 sorok és pontok negatív vagy nulla távolságú puffere mindig üres sokszög. A bemenet tartalmazhat point, MultiPoint, Polygon, MultiPolygon, LineString és MultiLineString gyűjteményt. A GeometryCollection nem lesz figyelmen kívül hagyva, ha meg van adva.

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

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. Érvényes értékek: mi (USA keleti régiója, USA nyugati középső régiója, 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 a `udid` kérelemben egy meg van adva. Ha például a Azure Maps-fiók az USA keleti régiójában található, akkor csak a földrajzra vonatkozó kérések lesznek elfogadva.
api-version	query	True	string	A Azure Maps API verziószáma.

Kérelem fejléce

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

Kérelem törzse

Name	Típus	Description
distances	number[]	Azon távolságok listája, amelyekhez a puffert ki kell számítani, egy-az-egyhez funkciónként a gyűjteményben, vagy egy a gyűjtemény összes szolgáltatásához.
geometries	GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Válaszok

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

Biztonság

AADToken

Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. 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 rest API-Azure Maps ra vonatkozó engedélyből álló 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ás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

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 javasoljuk, hogy használja a Azure Maps REST API-k kiszolgálóról kiszolgálóra való hozzáférését, 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, amely a Azure Maps erőforrás SAS listázási műveletéből jön 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 jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonat lejáratához, sebességéhez és régiójához. Más szóval az SAS-jogkivonattal az alkalmazások biztonságosabb módon szabályozhatják a hozzáférést, mint a megosztott kulcs.

Nyilvánosan közzétett alkalmazások esetében azt javasoljuk, hogy konfigurálja az engedélyezett források adott listáját a Térképfiók erőforráson a megjelenítési visszaélések korlátozása és az SAS-jogkivonat rendszeres megújítása érdekében.

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
BufferRequestBody	Egy featureCollection objektum és a távolságok listája. 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.
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észleteket az RFC 7946-os verziójában találja.
GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonGeometry	Érvényes `GeoJSON` geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.
GeoJsonGeometryCollection	Érvényes `GeoJSON GeometryCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonLineString	Érvényes `GeoJSON LineString` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiLineString	Érvényes `GeoJSON MultiLineString` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiPoint	Érvényes `GeoJSON MultiPoint` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonMultiPolygon	Érvényes `GeoJSON MultiPolygon` objektumtípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonPoint	Érvényes `GeoJSON Point` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
GeoJsonPolygon	Érvényes `GeoJSON Polygon` geometriatípus. A részleteket az RFC 7946-os verziójában találja.
JsonFormat	A válasz kívánt formátuma. Csak `json` a formátum támogatott.

BufferRequestBody

Egy featureCollection objektum és a távolságok listája. A funkció minden tulajdonságának tartalmaznia kell a geometryIdelemet, 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.

Name	Típus	Description
distances	number[]	Azon távolságok listája, amelyekhez a puffert ki kell számítani, egy-az-egyhez funkciónként a gyűjteményben, vagy egy a gyűjtemény összes szolgáltatásához.
geometries	GeoJsonFeatureCollection	Érvényes `GeoJSON FeatureCollection` objektumtípus. A részleteket az RFC 7946-os verziójában találja.

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 adattí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 hiba célja.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

GeoJsonFeature

Érvényes GeoJSON Feature objektumtípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
featureType	string	A szolgáltatás típusa. Az érték attól az adatmodelltől függ, amelybe az aktuális funkció tartozik. 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 : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.
id	string	A szolgáltatás 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 és FeatureCollection.

GeoJsonFeatureCollection

Érvényes GeoJSON FeatureCollection objektumtípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonGeometry

Érvényes GeoJSON geometriai objektum. A típusnak a hét érvényes GeoJSON-geometriatípus egyikének kell lennie : Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon és GeometryCollection. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonGeometryCollection

Érvényes GeoJSON GeometryCollection objektumtípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonLineString

Érvényes GeoJSON LineString geometriatípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonMultiLineString

Érvényes GeoJSON MultiLineString geometriatípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonMultiPoint

Érvényes GeoJSON MultiPoint geometriatípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonMultiPolygon

Érvényes GeoJSON MultiPolygon objektumtípus. A részleteket az RFC 7946-os verziójában találja.

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 és FeatureCollection.

GeoJsonPoint

Érvényes GeoJSON Point geometriatípus. A részleteket az RFC 7946-os verziójában találja.

Name	Típus	Description
coordinates	number[]	Az A `Position` két vagy több elemet tartalmazó számtömb. Az első két elem a hosszúság és a szélesség, pontosan ebben a sorrendben. A magasság/magasság nem kötelező harmadik elem. A részleteket az RFC 7946-os verziójában találja.
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 és FeatureCollection.

GeoJsonPolygon

Érvényes GeoJSON Polygon geometriatípus. A részleteket az RFC 7946-os verziójában találja.

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 és 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 object Notation Data Interchange formátuma