Referensi Defender untuk IoT API
Bagian ini menjelaskan API publik yang didukung oleh Pertahanan Microsoft untuk IoT. API Defender untuk IoT diatur oleh Ketentuan Penggunaan dan Lisensi API Microsoft.
Gunakan API Defender for IoT untuk mengakses data yang ditemukan oleh sensor dan konsol manajemen lokal dan melakukan tindakan dengan data tersebut.
Koneksi API diamankan melalui SSL.
Membuat token akses API
Banyak API Defender for IoT memerlukan token akses. Token akses tidak diperlukan untuk API autentikasi.
Untuk menghasilkan token:
Pada jendela Pengaturan Sistem, pilih Token>Akses Integrasi.
Pilih Buat token.
Pada Deskripsi, jelaskan untuk apa token baru itu, lalu pilih Buat.
Token akses muncul. Salin, karena tidak akan ditampilkan lagi.
Pilih Selesai.
Token yang Anda buat muncul di kotak dialog Access Tokens. Digunakan menunjukkan terakhir kali panggilan eksternal dengan token ini diterima.
N/A pada bidang Digunakan menunjukkan bahwa koneksi antara sensor dan server yang terhubung tidak berfungsi.
Setelah membuat token, tambahkan header HTTP berjudul Otorisasi ke permintaan Anda, dan set nilainya ke token yang Anda buat.
Referensi versi API Sensor
| Versi | API yang Didukung |
|---|---|
| Tidak ada versi | Autentikasi dan manajemen kata sandi: - set_password (Ubah kata sandi Anda) - set_password_by_admin (Memperbarui kata sandi pengguna menurut admin) - validasi (Validasi kredensial pengguna) |
| Baru dalam versi 1 | Inventaris: - koneksi (Mengambil informasi koneksi perangkat) - cves (Ambil informasi tentang CVE) - perangkat (Ambil informasi perangkat) Pemberitahuan: - pemberitahuan (Ambil informasi pemberitahuan) - peristiwa (Ambil peristiwa garis waktu) Kerentanan: - operasional (Ambil kerentanan operasional) - perangkat (Ambil informasi kerentanan perangkat) - mitigasi (Ambil langkah-langkah mitigasi) - keamanan (Mengambil kerentanan keamanan) |
| Baru di versi 2 | Pemberitahuan: - Pembaruan untuk pemberitahuan (Ambil informasi pemberitahuan) |
Referensi versi API konsol manajemen lokal
| Versi | API |
|---|---|
| Tidak ada versi | Autentikasi dan manajemen kata sandi: - set_password (Ubah kata sandi) - set_password_by_admin (Pembaruan kata sandi pengguna oleh admin sistem) - validasi (Autentikasi kredensial pengguna) |
| Baru dalam versi 1 | Situs - appliance (Mengelola appliance sensor OT) Inventaris: - perangkat (Ambil semua informasi perangkat) Pemberitahuan: - pemberitahuan (Ambil informasi pemberitahuan) - maintenanceWindow (Buat pengecualian pemberitahuan) |
| Baru di versi 2 | Pemberitahuan: - Pembaruan untuk pemberitahuan (Ambil informasi pemberitahuan) - pcap (Meminta pemberitahuan PCAP) |
| Baru dalam versi 3 | API Integrasi: - koneksi (Dapatkan koneksi perangkat) - perangkat (Dapatkan detail untuk perangkat) - devicecves (Dapatkan CVE perangkat) - perangkat (Buat dan perbarui perangkat) - deleteddevices (Dapatkan perangkat yang dihapus) - sensor (Dapatkan sensor) |
Catatan
API integrasi dimaksudkan untuk berjalan terus menerus dan membuat aliran data yang terus berjalan, seperti untuk mengkueri data baru dari lima menit terakhir. API integrasi mengembalikan data dengan tanda waktu.
Untuk sekadar mengkueri data, gunakan API reguler non-integrasi sebagai gantinya, untuk konsol manajemen lokal untuk mengkueri semua perangkat, atau untuk sensor tertentu untuk mengkueri perangkat dari sensor tersebut saja.
Waktu epoch
Di semua nilai tanda waktu Defender for IoT, waktu Epoch sama dengan 1/1/1970.
Langkah berikutnya
Untuk informasi selengkapnya, lihat:
- Kelola inventaris perangkat Anda dari portal Azure
- Mengelola inventaris perangkat OT Anda dari konsol sensor
- Kelola inventaris perangkat OT Anda dari konsol manajemen lokal
- Menampilkan dan mengelola peringatan dari portal Azure
- Melihat peringatan pada sensor Anda
- Bekerja dengan pemberitahuan di konsol manajemen lokal