Bagikan melalui

Membuat dan mengelola ruang kerja di Azure API Management

BERLAKU UNTUK: Premium | Premium v2

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.

Note

  • 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 mengaitkan gateway ruang kerja menggunakan portal Microsoft Azure
  • Secara opsional, isolasi gateway ruang kerja di jaringan virtual Azure
  • Menetapkan izin untuk area kerja

Note

  • Saat ini, membuat gateway ruang kerja adalah operasi jangka panjang yang dapat memakan waktu hingga 3 jam atau lebih untuk diselesaikan.
  • Menghubungkan beberapa ruang kerja dengan gateway hanya tersedia untuk gateway yang dibuat setelah 15 April 2025. Pelajari selengkapnya tentang gateway ruang kerja bersama.

Prerequisites

  • Sebuah instans API Management. Jika perlu, buat satu 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) Subnet di jaringan virtual Azure baru atau yang sudah ada 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

  1. Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.

  2. Di menu sebelah kiri, di bawah API, pilih Ruang> Kerja+ Tambahkan.

  3. Pada tab Dasar, masukkan Nama tampilan deskriptif, Nama sumber daya, dan Deskripsi opsional untuk ruang kerja. Pilih Selanjutnya.

  4. Pada tab Gateway , konfigurasikan pengaturan untuk gateway ruang kerja.

    Cuplikan layar pembuatan gateway ruang kerja di portal.

    • Pilih Buat baru untuk membuat gateway ruang kerja baru, atau pilih Gunakan yang sudah ada untuk mengaitkan ruang kerja dengan gateway yang sudah ada yang memiliki ruang kerja lain yang disebarkan di dalamnya.

    • Jika Anda memilih untuk membuat gateway baru:

      • Di Detail Gateway, masukkan nama gateway baru dan pilih jumlah unit skala Unit. Biaya gateway didasarkan pada jumlah unit. Untuk informasi selengkapnya, lihat Harga API Management.

      • Di Jaringan, pilih Konfigurasi jaringan untuk gateway ruang kerja Anda.

        Important

        Rencanakan konfigurasi jaringan ruang kerja Anda dengan hati-hati. Anda tidak dapat mengubah konfigurasi jaringan setelah membuat ruang kerja.

      • Jika Anda memilih Akses publik masuk, akses privat keluar (integrasi jaringan virtual) atau Akses privat masuk, akses privat keluar (injeksi jaringan virtual), 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.

  5. Pilih Selanjutnya. Setelah validasi selesai, pilih Buat.

    Note

    Pembuatan gateway ruang kerja baru, jika dipilih, dapat memakan waktu hingga beberapa jam untuk diselesaikan. 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.

Note

  • 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.
  • Selama gateway ruang kerja sedang dibuat, panggilan runtime ke API ruang kerja tidak akan berhasil.

Menugaskan pengguna ke workspace - 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 yang terlingkup layanan dan peran RBAC ruang kerja yang sesuai ruang kerja, atau diberikan izin yang setara menggunakan peran kustom.

Untuk mengelola gateway ruang kerja, sebaiknya tetapkan juga peran RBAC yang disediakan oleh Azure yang cakupannya pada gateway ruang kerja.

Note

Untuk manajemen yang lebih mudah, siapkan grup Microsoft Entra untuk menetapkan izin ruang kerja ke beberapa pengguna.

Menetapkan peran cakupan layanan

  1. Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.

  2. Di menu sebelah kiri, pilih Kontrol akses (IAM)>+ Tambahkan.

  3. 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 berbasis ruang kerja

  1. Di menu untuk instans API Management Anda, di bawah API, pilih Ruang Kerja> nama ruang kerja yang Anda buat.

  2. Di jendela Ruang Kerja, pilih

  3. 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 untuk API Management Workspace
    • API Management Workspace API Product Manager

Tetapkan peran yang mencakup gateway

  1. Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.

  2. Di menu sebelah kiri, di bawah APIs, pilih Workspaces> nama ruang kerja Anda.

  3. Di menu sebelah kiri ruang kerja, pilih Gateway, dan pilih gateway ruang kerja.

  4. Di menu sebelah kiri, pilih Kontrol akses (IAM)>+ Tambahkan.

  5. 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 menyesuaikan skala gateway.

    • Owner
    • Contributor
    • Reader

Mengaktifkan pengaturan diagnostik untuk memantau API ruang kerja

Konfigurasikan pengaturan untuk mengumpulkan log Azure Monitor untuk ruang kerja dan mengirimkannya ke ruang kerja Analitik Log sehingga tim ruang kerja dapat memantau API mereka sendiri sementara tim platform API dapat mengakses log terpusat untuk instans API Management. Lihat diagram berikut:

Diagram pengelogan federasi di API Management.

Untuk mengumpulkan log Azure Monitor untuk ruang kerja, pengaturan diagnostik diperlukan di tingkat layanan dan ruang kerja:

  1. Pertama, aktifkan pengaturan diagnostik di tingkat layanan untuk pengumpulan log gateway API Management, jika pengaturan belum diaktifkan. Sebaiknya kirim log ke ruang kerja Analitik Log. Untuk informasi selengkapnya, lihat Mengonfigurasi pengaturan diagnostik untuk API Management.

  2. Kemudian, aktifkan pengaturan diagnostik di tingkat ruang kerja untuk mengirim log gateway API Management ke ruang kerja Analitik Log yang sama. Pengaturan ini mengumpulkan log untuk semua gateway ruang kerja yang terkait dengan ruang kerja.

    Important

    Pengaturan diagnostik di tingkat layanan mengonfigurasi pengelogan di seluruh instans API Management, termasuk ruang kerja yang mengaktifkan pengaturan diagnostik tingkat ruang kerja. Jika Anda tidak mengaktifkan pengaturan diagnostik tingkat ruang kerja, log gateway ruang kerja tidak akan dikumpulkan atau diagregasikan di dalam Analitik Log.

    Note

    Secara default, anggota tim ruang kerja yang diberi peran RBAC ruang kerja bawaan tidak memiliki izin untuk mengedit pengaturan diagnostik di ruang kerja. Tim platform API memiliki izin tersebut.

Untuk mengonfigurasi pengaturan diagnostik ruang kerja guna mengumpulkan log gateway di ruang kerja:

  1. Masuk ke portal Microsoft Azure, dan buka instans API Management Anda.

  2. Di menu sebelah kiri, di bawah APIs, pilih Workspaces> nama ruang kerja Anda.

  3. Di menu sebelah kiri ruang kerja, di bawah Pemantauan, pilih Pengaturan>diagnostik+ Tambahkan pengaturan diagnostik.

  4. Pada halaman Pengaturan diagnostik, masukkan atau pilih detail untuk pengaturan:

    1. Nama pengaturan diagnostik: Masukkan nama deskriptif.
    2. Grup kategori: Secara opsional buat pilihan untuk skenario Anda.
    3. Di bawah Kategori: Pilih Log yang terkait dengan ApiManagement Gateway untuk mengumpulkan log gateway untuk API di ruang kerja ini.
    4. Di bawah Detail tujuan, pilih untuk mengirim log ke ruang kerja Azure Log Analytics yang sama yang ditentukan dalam pengaturan diagnostik tingkat layanan dan di pengaturan diagnostik tingkat ruang kerja lainnya.
    5. Pilih Simpan.

Note

  • Saat ini, hanya log gateway yang dapat dikumpulkan untuk ruang kerja.
  • Akses log tingkat ruang kerja dengan menavigasi keLog> di menu sebelah kiri ruang kerja.

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.

Resource Guide
APIs Tutorial: Mengimpor dan memublikasikan API pertama Anda
Products Tutorial: Membuat dan menerbitkan produk
Subscriptions Langganan di API Management Azure

Membuat langganan di API Management
Policies Tutorial: Mengubah dan melindungi API Anda

Kebijakan dalam Manajemen API Azure

Mengatur atau mengedit kebijakan API Management
Nilai yang diberi nama Mengelola rahasia menggunakan nilai bernama
Backends Menggunakan backend di Azure API Management
Fragmen kebijakan Menggunakan kembali konfigurasi kebijakan dalam definisi kebijakan API Management Anda
Schemas Memvalidasi konten
Groups Membuat dan menggunakan grup untuk mengelola akun pengembang
Notifications Cara mengonfigurasi pemberitahuan dan templat pemberitahuan

Konten terkait

  • Last updated on