Spatial - Post Buffer

Referensi

Service:: Maps

API Version:: 2022-08-01

Gunakan untuk mendapatkan tempat FeatureCollection setiap fitur adalah buffer di sekitar fitur input yang diindeks yang sesuai.

Post Buffer API adalah permintaan HTTP POST yang mengembalikan FeatureCollection di mana setiap fitur adalah buffer di sekitar fitur input yang diindeks yang sesuai. Buffer dapat berada di luar atau di dalam fitur yang disediakan, tergantung pada jarak yang disediakan dalam input. Harus ada satu jarak yang disediakan per Fitur dalam FeatureCollection input, atau jika hanya satu jarak yang disediakan, maka jarak tersebut diterapkan ke setiap fitur dalam koleksi. Buffer positif (atau negatif) geometri didefinisikan sebagai jumlah Minkowski (atau perbedaan) geometri dengan lingkaran radius yang sama dengan nilai absolut jarak buffer. API buffer selalu mengembalikan hasil poligonal. Buffer garis dan titik negatif atau jarak nol selalu merupakan poligon kosong. Input mungkin berisi kumpulan Point, MultiPoint, Polygon, MultiPolygon, LineString, dan MultiLineString. GeometryCollection akan diabaikan jika disediakan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.
geography	path	True	string	Lokasi Akun Azure Maps. Nilai yang valid adalah kita (US Timur, US Tengah Barat, AS Barat 2) dan Eropa (Eropa Utara, Eropa Barat). Parameter ini diperlukan ketika `udid` disediakan dalam permintaan. Misalnya, jika Akun Azure Maps terletak di US Timur, hanya permintaan kepada kami geografi yang akan diterima.
api-version	query	True	string	Nomor versi API Azure Maps.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Isi Permintaan

Nama	Jenis	Deskripsi
distances	number[]	Daftar jarak untuk menghitung buffer untuk, satu-ke-satu per Fitur dalam koleksi, atau satu untuk semua Fitur dalam koleksi.
geometries	GeoJsonFeatureCollection	Jenis objek yang valid `GeoJSON FeatureCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.

Respons

Nama	Jenis	Deskripsi
200 OK	BufferResult	OK
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa Azure Maps akun sumber daya atau sub-sumber daya. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, saat ini dapat diperlakukan sebagai kunci master ke akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server Azure Maps REST API tempat kunci ini dapat disimpan dengan aman.

Type: apiKey
In: header

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol halus ke kedaluwarsa, laju, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

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

Definisi

Nama	Deskripsi
BufferRequestBody	Objek dengan FeatureCollection dan daftar jarak. Semua properti fitur harus berisi `geometryId`, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.
BufferResult	Objek ini dikembalikan dari panggilan Buffer Spasial yang berhasil.
BufferSummary
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GeoJsonFeature	Jenis objek yang valid `GeoJSON Feature` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonFeatureCollection	Jenis objek yang valid `GeoJSON FeatureCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometry	Objek geometri yang valid `GeoJSON` . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonGeometryCollection	Jenis objek yang valid `GeoJSON GeometryCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonLineString	Jenis geometri yang valid `GeoJSON LineString` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiLineString	Jenis geometri yang valid `GeoJSON MultiLineString` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPoint	Jenis geometri yang valid `GeoJSON MultiPoint` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonMultiPolygon	Jenis objek yang valid `GeoJSON MultiPolygon` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPoint	Jenis geometri yang valid `GeoJSON Point` . Silakan merujuk ke RFC 7946 untuk detailnya.
GeoJsonPolygon	Jenis geometri yang valid `GeoJSON Polygon` . Silakan merujuk ke RFC 7946 untuk detailnya.
JsonFormat	Format respons yang diinginkan. Hanya `json` format yang didukung.

BufferRequestBody

Objek dengan FeatureCollection dan daftar jarak. Semua properti fitur harus berisi geometryId, yang digunakan untuk mengidentifikasi geometri dan peka huruf besar/kecil.

Nama	Jenis	Deskripsi
distances	number[]	Daftar jarak untuk menghitung buffer untuk, satu-ke-satu per Fitur dalam koleksi, atau satu untuk semua Fitur dalam koleksi.
geometries	GeoJsonFeatureCollection	Jenis objek yang valid `GeoJSON FeatureCollection` . Silakan merujuk ke RFC 7946 untuk detailnya.

BufferResult

Objek ini dikembalikan dari panggilan Buffer Spasial yang berhasil.

Nama	Jenis	Deskripsi
result	GeoJsonFeatureCollection	FeatureCollection buffer untuk input.
summary	BufferSummary

BufferSummary

Nama	Jenis	Deskripsi
information	string	Informasi tentang apa yang terjadi selama panggilan.
udid	string	udid untuk data pengguna jika ada

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GeoJsonFeature

Jenis objek yang valid GeoJSON Feature . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
featureType	string	Jenis fitur. Nilai tergantung pada model data, fitur saat ini adalah bagian dari. Beberapa model data mungkin memiliki nilai kosong.
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	Objek geometri yang valid `GeoJSON` . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.
id	string	Pengidentifikasi untuk fitur tersebut.
type	string: Feature	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonFeatureCollection

Jenis objek yang valid GeoJSON FeatureCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
features	GeoJsonFeature[]	Berisi daftar objek yang valid `GeoJSON Feature` .
type	string: FeatureCollection	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometry

Objek geometri yang valid GeoJSON . Jenisnya harus salah satu dari tujuh jenis geometri GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon dan GeometryCollection. Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
type	GeoJsonObjectType	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonGeometryCollection

Jenis objek yang valid GeoJSON GeometryCollection . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	Berisi daftar objek geometri yang valid `GeoJSON` . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: GeometryCollection	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonLineString

Jenis geometri yang valid GeoJSON LineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson LineString` untuk geometri.
type	string: LineString	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiLineString

Jenis geometri yang valid GeoJSON MultiLineString . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson MultiLineString` untuk geometri.
type	string: MultiLineString	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPoint

Jenis geometri yang valid GeoJSON MultiPoint . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson MultiPoint` untuk geometri.
type	string: MultiPoint	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonMultiPolygon

Jenis objek yang valid GeoJSON MultiPolygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Berisi daftar objek yang valid `GeoJSON Polygon` . Perhatikan bahwa koordinat di GeoJSON dalam urutan x, y (bujur, lintang).
type	string: MultiPolygon	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPoint

Jenis geometri yang valid GeoJSON Point . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	`Position` adalah array angka dengan dua elemen atau lebih. Dua elemen pertama adalah bujur dan lintang, tepatnya dalam urutan tersebut. Ketinggian/Elevasi adalah elemen ketiga opsional. Silakan merujuk ke RFC 7946 untuk detailnya.
type	string: Point	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

GeoJsonPolygon

Jenis geometri yang valid GeoJSON Polygon . Silakan merujuk ke RFC 7946 untuk detailnya.

Nama	Jenis	Deskripsi
coordinates	number[]	Koordinat `GeoJson Polygon` untuk jenis geometri.
type	string: Polygon	Menentukan jenis.`GeoJSON` Harus salah satu dari sembilan jenis objek GeoJSON yang valid - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature dan FeatureCollection.

JsonFormat

Format respons yang diinginkan. Hanya json format yang didukung.

Nama	Jenis	Deskripsi
json	string	Format Pertukaran Data Notasi Objek JavaScript