Dataset - Create

Layanan:

Maps Creator

Versi API:

2023-03-01-preview

Gunakan untuk membuat himpunan data.

Create API adalah permintaan HTTP POST yang memungkinkan pemanggil membuat himpunan data dari data yang diunggah ke Azure Maps Data Registry dan dikonversi menggunakan Azure Maps Conversion Service. Anda juga dapat membuat himpunan data secara langsung menggunakan data yang diunggah ke Azure Maps Data Registry, asalkan data yang diunggah adalah zip file GeoJSON yang sesuai dengan format ontologi fasilitas. Untuk informasi selengkapnya tentang layanan registri data, lihat Cara membuat registri data.

Untuk informasi selengkapnya, lihat Membuat himpunan data menggunakan paket GeoJson

Kirim Permintaan Buat

Untuk membuat himpunan data Anda, terbitkan POST permintaan dengan parameter yang diperlukan. Create API adalah operasi jangka panjang.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview

Dengan parameter opsional:

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={datasetId}&description={description}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
geography	path	True	string	Parameter ini menentukan lokasi sumber daya Azure Maps Creator. Nilai yang valid adalah kita dan Uni Eropa.
api-version	query	True	string	Nomor versi API Azure Maps.
conversionId	query		string	ID untuk membuat himpunan data. conversionId harus diperoleh dari panggilan yang berhasil ke API Konversi Layanan Konversi. Hanya satu conversionId yang dapat disediakan per panggilan API. conversionId dan udid adalah parameter yang saling eksklusif.
datasetId	query		string	ID himpunan data yang akan ditambahkan.
description	query		string	Deskripsi yang akan diberikan ke himpunan data.
outputOntology	query		outputOntology	Ontologi untuk paket zip yang diunggah yang berisi file GeoJSON. outputOntology diperlukan jika udid disediakan, namun, saling eksklusif dengan conversionId. Saat ini, hanya fasilitas nilai-2.0 yang didukung.
udid	query		string	ID data unik (udid) untuk membuat himpunan data. Harus sama dengan yang udid digunakan saat membuat registri Data. Hanya satu udid yang dapat disediakan per panggilan API. parameter outputOntology harus disediakan dengan udid. conversionId dan udid adalah parameter yang saling eksklusif.

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.

Respons

Nama	Jenis	Deskripsi
202 Accepted		Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Operation-Location untuk mendapatkan status. Header Operation-Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga.

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory . 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 direktori Azure Active. * 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.

• Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Jenis: apiKey
Dalam: query

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.

Jenis: apiKey
Dalam: header

Contoh

Create dataset from a converted CAD file provided by conversionId

Create dataset from a zip of GeoJSON files provided by udid

Create dataset with Udid and append to it a dataset created with conversionId

Create dataset with Udid and append to it a dataset created with udid

Create dataset from a converted CAD file provided by conversionId

Permintaan sampel

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&outputOntology=facility-2.0

Respon sampel

Kode status:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset from a zip of GeoJSON files provided by udid

Permintaan sampel

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0

Respon sampel

Kode status:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with conversionId

Permintaan sampel

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&conversionId={conversionId}&udid={udid}&outputOntology=facility-2.0&datasetId={conversionId}

Respon sampel

Kode status:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Create dataset with Udid and append to it a dataset created with udid

Permintaan sampel

HTTP

POST https://us.atlas.microsoft.com/datasets?api-version=2023-03-01-preview&udid={udid}&outputOntology=facility-2.0&datasetId={udid}

Respon sampel

Kode status:

202

Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2023-03-01-preview
Access-Control-Expose-Headers: Operation-Location

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
outputOntology	Ontologi untuk paket zip yang diunggah yang berisi file GeoJSON. outputOntology diperlukan jika udid disediakan, namun, saling eksklusif dengan conversionId. Saat ini, hanya fasilitas nilai-2.0 yang didukung.

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.

outputOntology

Ontologi untuk paket zip yang diunggah yang berisi file GeoJSON. outputOntology diperlukan jika udid disediakan, namun, saling eksklusif dengan conversionId. Saat ini, hanya fasilitas nilai-2.0 yang didukung.

Nama	Jenis	Deskripsi
facility-2.0	string