Conversion - Get

Referensi

Service:: Maps Creator

API Version:: 2.0

Gunakan untuk mengambil konversi data yang ditentukan.

Get API adalah permintaan HTTP GET yang memungkinkan pemanggil untuk mengambil konversi data yang berhasil yang sebelumnya dikirimkan menggunakan Layanan Konversi.

GET https://{geography}.atlas.microsoft.com/conversions/{conversionId}?api-version=2.0

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
conversionId	path	True	string	Id konversi untuk konten. `conversionId` harus diperoleh dari panggilan API Konversi yang berhasil.
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.

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	Conversion	Mengembalikan detail konversi yang ditentukan.
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 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

Get the details for one conversion operation

Sample Request

HTTP

GET https://us.atlas.microsoft.com/conversions/54398242-ea6c-1f31-4fa6-79b1ae0fc24d?api-version=2.0

Sample Response

Status code:: 200

{
  "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d",
  "udid": "31838736-8b84-11ea-bc55-0242ac130003",
  "created": "5/19/2020 9:00:00 AM +00:00",
  "description": "User provided description.",
  "ontology": "facility-2.0",
  "featureCounts": {
    "directoryInfo": 1,
    "level": 3,
    "facility": 1,
    "unit": 150,
    "category": 8,
    "areaElement": 0,
    "opening": 10
  }
}

Definisi

Nama	Deskripsi
Conversion	Informasi detail untuk permintaan konversi.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan

Conversion

Informasi detail untuk permintaan konversi.

Nama	Jenis	Deskripsi
conversionId	string	Id unik yang mewakili artefak dari proses konversi yang berhasil diselesaikan.
created	string	Tanggal dan waktu konversi ini.
description	string	Deskripsi yang diberikan pengguna tentang konten yang sedang dikonversi.
featureCounts	object	Ringkasan jumlah fitur dalam konversi ini.
ontology	string	Versi ontologi himpunan data ini.
udid	string	Id unik konten yang disediakan untuk membuat konversi ini.

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.

Share via