Mengembangkan plugin gateway

• Berlaku untuk:

  ✅ Windows Admin Center, ✅ Windows Admin Center Preview

Plugin gateway Windows Admin Center memungkinkan komunikasi API dari UI alat atau solusi Anda ke simpul target. Pusat Admin Windows menghosting layanan gateway yang menyampaikan perintah dan skrip dari plugin gateway untuk dijalankan pada simpul target. Layanan gateway dapat diperluas untuk menyertakan plugin gateway kustom yang mendukung protokol selain yang default.

Plugin gateway ini disertakan secara default dengan Pusat Admin Windows:

• Plugin gateway PowerShell
• Plugin gateway WMI

Jika Anda ingin berkomunikasi dengan protokol selain PowerShell atau WMI, seperti dengan REST, Anda dapat membangun plugin gateway Anda sendiri. Plugin gateway dimuat ke dalam AppDomain terpisah dari proses gateway yang ada, tetapi menggunakan tingkat elevasi yang sama untuk hak.

Catatan

Tidak terbiasa dengan berbagai jenis ekstensi? Pelajari selengkapnya tentang arsitektur ekstensibilitas dan jenis ekstensi.

Penting

SDK Pusat Admin Windows dan alat pengembang belum diperbarui untuk mendukung pengembangan plug-in gateway yang kompatibel dengan gateway modern Windows Admin Center. Mengikuti panduan ini tidak akan menghasilkan ekstensi yang kompatibel dengan gateway yang dimodernisasi.

Jika Anda tertarik untuk mengembangkan plug-in gateway untuk gateway yang dimodernisasi atau meningkatkan plug-in gateway yang sudah ada, kirim email ke wacextensionrequest@microsoft.com.

Menyiapkan lingkungan Anda

Jika Anda belum melakukannya, siapkan lingkungan Anda dengan menginstal dependensi dan prasyarat global yang diperlukan untuk semua proyek.

Membuat plugin gateway (pustaka C#)

Untuk membuat plugin gateway kustom, buat kelas C# baru yang mengimplementasikan IPlugIn antarmuka dari Microsoft.ManagementExperience.FeatureInterfaces namespace.

Catatan

Antarmuka IFeature , yang tersedia di versi SDK sebelumnya, sekarang ditandai sebagai usang. Semua pengembangan plugin gateway harus menggunakan IPlugIn (atau secara opsional kelas abstrak HttpPlugIn).

Unduh sampel dari GitHub

Untuk memulai dengan cepat dengan plugin gateway kustom, Anda dapat mengkloning atau mengunduh salinan sampel proyek plugin C# kami dari situs GitHub Windows Admin Center SDK kami.

Tambahkan konten

Tambahkan konten baru ke salinan kloning proyek plugin C# sampel Anda (atau proyek Anda sendiri) untuk berisi API kustom Anda, lalu buat file DLL plugin gateway kustom Anda untuk digunakan di langkah berikutnya.

Menyebarkan plugin untuk pengujian

Uji DLL plugin gateway kustom Anda dengan memuatnya ke dalam proses gateway Pusat Admin Windows.

Pusat Admin Windows mencari semua plugin dalam plugins folder di folder Data Aplikasi komputer saat ini (menggunakan nilai CommonApplicationData dari enumerasi Environment.SpecialFolder). Pada Windows 10 lokasi ini adalah C:\ProgramData\Server Management Experience. plugins Jika folder belum ada, Anda dapat membuat folder sendiri.

Catatan

Anda dapat mengambil alih lokasi plugin dalam build debug dengan memperbarui nilai konfigurasi "StaticsFolder". Jika Anda menelusuri kesalahan secara lokal, pengaturan ini ada di App.Config solusi Desktop.

Di dalam folder plugin (dalam contoh ini, C:\ProgramData\Server Management Experience\plugins)

• Buat folder baru dengan nama Name yang sama dengan nilai Feature properti di DLL plugin gateway kustom Anda (dalam proyek sampel kami, Name adalah "Sample Uno")
• Salin file DLL plugin gateway kustom Anda ke folder baru ini
• Mulai ulang proses Pusat Admin Windows

Setelah proses Admin Windows dimulai ulang, Anda akan dapat menjalankan API di DLL plugin gateway kustom Anda dengan mengeluarkan GET, PUT, PATCH, DELETE, atau POST ke http(s)://{domain|localhost}/api/nodes/{node}/features/{feature name}/{identifier}

Opsional: Lampirkan ke plugin untuk penelusuran kesalahan

Di Visual Studio 2017, dari menu Debug, pilih "Lampirkan ke Proses". Di jendela berikutnya, gulir daftar Proses yang Tersedia dan pilih SMEDesktop.exe, lalu klik "Lampirkan". Setelah debugger dimulai, Anda dapat menempatkan titik henti dalam kode fitur Anda lalu berolahraga melalui format URL di atas. Untuk proyek sampel kami (nama fitur: "Sample Uno") URL-nya adalah: "<http://localhost:6516/api/nodes/fake-server.my.domain.com/features/Sample%20Uno>"

Membuat ekstensi alat dengan Windows Admin Center SDK

Sekarang kita perlu membuat ekstensi alat tempat Anda dapat memanggil plugin gateway kustom Anda. Buat atau telusuri ke folder tempat Anda ingin menyimpan file proyek, membuka prompt perintah, dan mengatur folder tersebut sebagai direktori kerja. Menggunakan Windows Admin Center SDK yang diinstal sebelumnya, buat ekstensi baru dengan sintaks berikut:

wac create --company "{!Company Name}" --tool "{!Tool Name}"

Nilai	Penjelasan	Contoh
{!Company Name}	Nama perusahaan Anda (dengan spasi)	Contoso Inc
{!Tool Name}	Nama alat Anda (dengan spasi)	Manage Foo Works

Berikut adalah contoh penggunaan:

wac create --company "Contoso Inc" --tool "Manage Foo Works"

Ini membuat folder baru di dalam direktori kerja saat ini menggunakan nama yang Anda tentukan untuk alat Anda, menyalin semua file templat yang diperlukan ke dalam proyek Anda, dan mengonfigurasi file dengan nama perusahaan dan alat Anda.

Selanjutnya, ubah direktori ke dalam folder yang baru saja dibuat, lalu instal dependensi lokal yang diperlukan dengan menjalankan perintah berikut:

npm install

Setelah ini selesai, Anda telah menyiapkan semua yang Anda butuhkan untuk memuat ekstensi baru Anda ke Pusat Admin Windows.

Menyambungkan ekstensi alat Anda ke plugin gateway kustom Anda

Sekarang setelah Anda membuat ekstensi dengan Windows Admin Center SDK, Anda siap untuk menyambungkan ekstensi alat Anda ke plugin gateway kustom Anda, dengan mengikuti langkah-langkah berikut:

• Menambahkan modul kosong
• Menggunakan plugin gateway kustom Anda di ekstensi alat Anda

Bangun dan muat samping ekstensi Anda

Selanjutnya, bangun dan muat sisi ekstensi Anda ke Pusat Admin Windows. Buka jendela perintah, ubah direktori ke direktori sumber Anda, lalu Anda siap untuk membangun.

• Bangun dan sajikan dengan gulp:

  gulp build
  gulp serve -p 4201
  

Perhatikan bahwa Anda perlu memilih port yang saat ini gratis. Pastikan Anda tidak mencoba menggunakan port tempat Pusat Admin Windows dijalankan.

Proyek Anda dapat dimuat ke dalam instans lokal Pusat Admin Windows untuk pengujian dengan melampirkan proyek yang dilayani secara lokal ke Pusat Admin Windows.

• Luncurkan Pusat Admin Windows di browser web

• Buka debugger (F12)

• Buka Konsol dan ketik perintah berikut:

  MsftSme.sideLoad("http://localhost:4201")
  

• Merefresh browser web

Proyek Anda sekarang akan terlihat di daftar Alat dengan (sisi dimuat) di samping nama.

Menargetkan versi SDK Pusat Admin Windows yang berbeda

Menjaga ekstensi Anda tetap terbarui dengan perubahan SDK dan perubahan platform itu mudah. Baca tentang cara menargetkan versi SDK Pusat Admin Windows yang berbeda.