Spatial - Post Buffer
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 |
A válasz kívánt formátuma. Csak |
|
geography
|
path | True |
string |
Az 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 |
api-version
|
query | True |
string |
Az 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 használatban a Microsoft Entra ID biztonsági modellel együtt. Az Azure Maps-fiók egyedi azonosítóját jelöli, és lekérhető az Azure Maps felügyeleti síkjának Fiók API-jából. A Microsoft Entra ID-biztonság Azure Mapsben való használatához tekintse meg az alábbi cikkeket . |
Kérelem törzse
Name | Típus | Description |
---|---|---|
distances |
number[] |
A puffer kiszámításához szükséges távolságok listája, a gyűjtemény funkciónként egy-az-egyhez, vagy a gyűjtemény összes szolgáltatásához. |
geometries |
Érvényes |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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 szabályozható az 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 Azure Maps REST API-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á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ó megköveteli a fejléc használatát
x-ms-client-id
annak jelzéséhez, 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 az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.
* Az 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ásplatformról további információt a Microsoft identitásplatform áttekintése című témakörben talál.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
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íkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.
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 az 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ó.
Típus:
apiKey
In:
header
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat az Azure Maps-erőforrás Sas listázási műveletéből jön létre az Azure Felügyeleti síkon keresztül az Azure Portalon, a PowerShellen, a parancssori felületen, az Azure SDK-kon vagy a REST API-kon keresztül.
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.
Típus:
apiKey
In:
header
Példák
PostBuffer
Mintakérelem
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
]
}
Mintaválasz
{
"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 |
---|---|
Buffer |
Egy featureCollection objektum és a távolságok listája. A funkció minden tulajdonságának tartalmaznia kell , |
Buffer |
Ezt az objektumot egy sikeres térbeli pufferhívás adja vissza. |
Buffer |
|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Geo |
Érvényes |
Json |
A válasz kívánt formátuma. Csak |
BufferRequestBody
Egy featureCollection objektum és a távolságok listája. A funkció minden tulajdonságának tartalmaznia kell , geometryId
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[] |
A puffer kiszámításához szükséges távolságok listája, a gyűjtemény funkciónként egy-az-egyhez, vagy a gyűjtemény összes szolgáltatásához. |
geometries |
Érvényes |
BufferResult
Ezt az objektumot egy sikeres térbeli pufferhívás adja vissza.
Name | Típus | Description |
---|---|---|
result |
A bemenet puffereinek FeatureCollection tulajdonsága. |
|
summary |
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 |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
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: |
Érvényes |
id |
string |
A funkció azonosítója. |
type |
string:
Feature |
Megadja a típust |
GeoJsonFeatureCollection
Érvényes GeoJSON FeatureCollection
objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
Name | Típus | Description |
---|---|---|
features |
Az érvényes |
|
type |
string:
Feature |
Megadja a típust |
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 |
Geo |
Megadja a típust |
GeoJsonGeometryCollection
Érvényes GeoJSON GeometryCollection
objektumtípus. A részletekért tekintse meg az RFC 7946-ot .
Name | Típus | Description |
---|---|---|
geometries | GeoJsonGeometry[]: |
Érvényes geometriai objektumok listáját |
type |
string:
Geometry |
Megadja a típust |
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 |
type |
string:
Line |
Megadja a típust |
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 |
type |
string:
Multi |
Megadja a típust |
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 |
type |
string:
Multi |
Megadja a típust |
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 |
type |
string:
Multi |
Megadja a típust |
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 |
type |
string:
Point |
Megadja a típust |
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 |
type |
string:
Polygon |
Megadja a típust |
JsonFormat
A válasz kívánt formátuma. Csak json
a formátum támogatott.
Name | Típus | Description |
---|---|---|
json |
string |