Dataset - Create

  • Referensi
Service:
Maps Creator
API Version:
2.0

Gunakan untuk membuat himpunan data.

Create API adalah permintaan HTTP POST yang mengambil conversionId nilai paket gambar yang dikonversi dan mengembalikan datasetId properti himpunan data yang baru dibuat. Untuk informasi selengkapnya, lihat Membuat himpunan data.

Anda dapat menggunakan permintaan ini dalam skenario seperti mengunggah paket zip DWG untuk bangunan, mengonversi paket zip menggunakan layanan Azure Maps Conversion, dan membuat himpunan data dari paket zip yang dikonversi. Himpunan data yang dibuat dapat digunakan untuk membuat set petak peta menggunakan layanan Azure Maps Tileset dan dapat dikueri melalui layanan Azure Maps WFS.

Kirim Permintaan Buat

Untuk membuat himpunan data, Anda akan menggunakan POST permintaan di mana conversionId parameter kueri adalah ID yang mewakili paket zip DWG yang dikonversi, datasetId parameternya adalah ID himpunan data yang dibuat sebelumnya untuk ditambahkan dengan himpunan data saat ini dan, secara opsional, description parameter kueri akan berisi deskripsi (jika deskripsi tidak diberikan deskripsi default akan diberikan).

Create API adalah operasi jangka panjang.

POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}
With optional parameters: 
POST https://{geography}.atlas.microsoft.com/datasets?api-version=2.0&conversionId={conversionId}&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 True

string

ID unik yang digunakan untuk membuat himpunan data. conversionId harus diperoleh dari panggilan yang berhasil ke layanan Konversi Api Konversi dan dapat diberikan beberapa parameter kueri dengan nama yang sama (jika lebih dari satu disediakan).
datasetId
 query

string

ID untuk ditambahkan dengan himpunan data. Himpunan data harus berasal dari panggilan pembuatan himpunan data sebelumnya yang cocok dengan datasetId
description
 query

string

Deskripsi yang akan diberikan ke himpunan data.

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
200 OK

LongRunningOperationResult

Operasi sedang berjalan atau selesai. Jika operasi berhasil, gunakan header Resource-Location untuk mendapatkan jalur ke hasilnya.

Headers

Resource-Location: string
202 Accepted

Permintaan Diterima: Permintaan telah diterima untuk diproses. Silakan gunakan URL di Header Operation-Location untuk mendapatkan status.

Headers

Operation-Location: string
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.

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 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.

Type: apiKey
In: 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.

Type: apiKey
In: header

Contoh

Create dataset from a converted CAD file provided by conversionId

Sample Request

POST https://us.atlas.microsoft.com/datasets?api-version=2.0&conversionId=[conversionId]

Sample Response

Status code:
200 
Resource-Location: https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0
Response Body
{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded"
}
Status code:
202 
Operation-Location: https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0
Access-Control-Expose-Headers: Operation-Location

Definisi

Nama Deskripsi
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
LongRunningOperationResult

Model respons untuk API Operasi Long-Running.
LroStatus

Status permintaan.

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.

LongRunningOperationResult

Model respons untuk API Operasi Long-Running.

Nama Jenis Deskripsi
created

string

Tanda waktu yang dibuat.
error

ErrorDetail

Detail kesalahan.
operationId

string

Id untuk operasi jangka panjang ini.
status

LroStatus

Status permintaan.
warning

ErrorDetail

Detail kesalahan.

LroStatus

Status permintaan.

Nama Jenis Deskripsi
Failed

string

Permintaan memiliki satu atau beberapa kegagalan.
NotStarted

string

Permintaan belum mulai diproses.
Running

string

Permintaan telah mulai diproses.
Succeeded

string

Permintaan berhasil diselesaikan.