Membuat dan mengelola ruang kerja di Azure API Management
BERLAKU UNTUK: Premium
Siapkan ruang kerja untuk memungkinkan tim API mengelola dan mengolah API mereka sendiri, sambil menyediakan tim platform API dengan alat untuk mengamati, mengatur, dan memelihara platform API Management. Setelah Anda membuat ruang kerja dan menetapkan izin, kolaborator ruang kerja dapat membuat dan mengelola API, produk, langganan, dan sumber daya terkait mereka sendiri.
Catatan
- Fitur ruang kerja terbaru didukung dalam API Management REST API versi 2023-09-01-preview atau yang lebih baru.
- Untuk pertimbangan harga, lihat Harga API Management.
Ikuti langkah-langkah dalam artikel ini untuk:
- Membuat ruang kerja API Management dan gateway ruang kerja menggunakan portal Azure
- Secara opsional, isolasi gateway ruang kerja di jaringan virtual Azure
- Menetapkan izin ke ruang kerja
Catatan
- Saat ini, membuat gateway ruang kerja adalah operasi jangka panjang yang dapat memakan waktu hingga 3 jam atau lebih untuk diselesaikan.
- Kami memperkenalkan kemampuan untuk mengaitkan beberapa ruang kerja dengan gateway ruang kerja, membantu organisasi mengelola API dengan ruang kerja dengan biaya yang lebih rendah. Fitur ini sedang diluncurkan mulai Desember 2024 dan mungkin tidak tersedia untuk semua layanan yang memenuhi syarat sebelum Januari. Pelajari lebih lanjut
Prasyarat
- Sebuah instans API Management. Jika perlu, buat di tingkat yang didukung.
- Peran Pemilik atau Kontributor pada grup sumber daya tempat instans API Management disebarkan, atau izin yang setara untuk membuat sumber daya di grup sumber daya.
- (Opsional) Jaringan virtual dan subnet Azure yang sudah ada atau baru untuk mengisolasi lalu lintas masuk dan keluar gateway ruang kerja. Untuk opsi dan persyaratan konfigurasi, lihat Persyaratan sumber daya jaringan untuk gateway ruang kerja.
Membuat ruang kerja - portal
Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.
Di menu sebelah kiri, di bawah API, pilih Ruang> Kerja+ Tambahkan.
Pada tab Dasar, masukkan Nama tampilan deskriptif, Nama sumber daya, dan Deskripsi opsional untuk ruang kerja. Pilih Selanjutnya.
Pada tab Gateway , konfigurasikan pengaturan untuk gateway ruang kerja:
Di Detail gateway, masukkan nama gateway dan pilih jumlah Unit skala. Biaya gateway didasarkan pada jumlah unit yang Anda pilih. Untuk informasi selengkapnya, lihat Harga API Management.
Di Jaringan, pilih Konfigurasi jaringan untuk gateway ruang kerja Anda.
Penting
Rencanakan konfigurasi jaringan ruang kerja Anda dengan hati-hati. Anda tidak dapat mengubah konfigurasi jaringan setelah membuat ruang kerja.
Jika Anda memilih konfigurasi jaringan yang menyertakan akses jaringan masuk atau keluar privat privat, pilih Jaringan virtual dan Subnet untuk mengisolasi gateway ruang kerja, atau membuat yang baru. Untuk persyaratan jaringan, lihat Persyaratan sumber daya jaringan untuk gateway ruang kerja.
Pilih Selanjutnya. Setelah validasi selesai, pilih Buat.
Diperlukan waktu beberapa menit hingga beberapa jam untuk membuat ruang kerja, gateway ruang kerja, dan sumber daya terkait. Untuk melacak kemajuan penyebaran di portal Azure, buka grup sumber daya gateway. Di menu sebelah kiri, di bawah Pengaturan, pilih Penyebaran.
Setelah penyebaran selesai, ruang kerja baru muncul dalam daftar di halaman Ruang Kerja. Pilih ruang kerja untuk mengelola pengaturan dan sumber dayanya.
Catatan
- Untuk menampilkan nama host runtime gateway dan detail gateway lainnya, pilih ruang kerja di portal. Di bawah Penyebaran + infrastruktur, pilih Gateway, dan pilih nama gateway ruang kerja.
- Saat gateway ruang kerja sedang dibuat, panggilan runtime ke API ruang kerja tidak akan berhasil.
Menetapkan pengguna ke ruang kerja - portal
Setelah membuat ruang kerja, tetapkan izin kepada pengguna untuk mengelola sumber daya ruang kerja. Setiap pengguna ruang kerja harus diberi peran RBAC ruang kerja cakupan layanan dan peran RBAC yang terlingkup ruang kerja, atau diberikan izin yang setara menggunakan peran kustom.
Untuk mengelola gateway ruang kerja, sebaiknya tetapkan juga peran RBAC yang disediakan Azure yang dilingkup ke gateway ruang kerja.
Catatan
Untuk manajemen yang lebih mudah, siapkan grup Microsoft Entra untuk menetapkan izin ruang kerja ke beberapa pengguna.
- Untuk daftar peran ruang kerja bawaan, lihat Cara menggunakan kontrol akses berbasis peran di API Management.
- Untuk langkah-langkah menetapkan peran, lihat Menetapkan peran Azure menggunakan portal.
Menetapkan peran cakupan layanan
Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.
Di menu sebelah kiri, pilih Kontrol akses (IAM)>+ Tambahkan.
Tetapkan salah satu peran cakupan layanan berikut ke setiap anggota ruang kerja:
- Pengembang API Api Management Service Workspace API
- API Management Service Workspace API Product Manager
Menetapkan peran cakupan ruang kerja
Di menu untuk instans API Management Anda, di bawah API, pilih Ruang> Kerja nama ruang kerja yang Anda buat.
Di jendela Ruang Kerja, pilih Kontrol akses (IAM)>+ Tambahkan.
Tetapkan salah satu peran cakupan ruang kerja berikut ke anggota ruang kerja sehingga mereka dapat mengelola API ruang kerja dan sumber daya lainnya.
- Pembaca Ruang Kerja API Management
- Kontributor Ruang Kerja API Management
- Pengembang API Api Management Workspace API
- API Management Workspace API Product Manager
Menetapkan peran cakupan gateway
Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.
Di menu sebelah kiri, di bawah API, pilih Ruang> Kerja nama ruang kerja Anda.
Di menu sebelah kiri ruang kerja, pilih Gateway, dan pilih gateway ruang kerja.
Di menu sebelah kiri, pilih Kontrol akses (IAM)>+ Tambahkan.
Tetapkan salah satu peran berikut untuk setiap anggota ruang kerja. Minimal, sebaiknya tetapkan peran Pembaca untuk melihat pengaturan gateway. Pemilik dan Kontributor dapat mengelola pengaturan gateway termasuk menskalakan gateway.
- Pemilik
- Kontributor
- Pembaca
Mulai menggunakan ruang kerja Anda
Bergantung pada peran mereka di ruang kerja, pengguna mungkin memiliki izin untuk membuat API, produk, langganan, dan sumber daya lainnya, atau mereka mungkin memiliki akses baca-saja ke beberapa atau semuanya.
Untuk mulai mengelola, melindungi, dan menerbitkan API di ruang kerja, lihat panduan berikut.