Menyinkronkan API dari instans API Management (pratinjau)
Artikel ini menunjukkan cara mengintegrasikan instans API Management sehingga API instans terus diperbarui di inventarisasi pusat API Anda.
Tentang mengintegrasikan instans API Management
Meskipun Anda dapat menggunakan Azure CLI untuk mengimpor API sesuai permintaan dari Azure API Management ke Azure API Center, mengintegrasikan (menautkan) instans API Management memungkinkan sinkronisasi berkelanjutan sehingga inventarisasi API tetap terbaru. Azure API Center juga dapat menyinkronkan API dari sumber termasuk Amazon API Gateway.
Saat Anda mengintegrasikan instans API Management sebagai sumber API, hal berikut ini terjadi:
- Semua API, dan definisi API opsional (spesifikasi), dari instans API Management ditambahkan ke inventarisasi pusat API.
- Anda mengonfigurasi lingkungan jenis Azure API Management di pusat API.
- Penyebaran terkait dibuat untuk setiap definisi API yang disinkronkan dari API Management.
API Management API secara otomatis disinkronkan ke pusat API setiap kali pengaturan API yang ada berubah (misalnya, versi baru ditambahkan), API baru dibuat, atau API dihapus. Sinkronisasi ini satu arah dari API Management ke pusat API Azure Anda, yang berarti pembaruan API di pusat API tidak disinkronkan kembali ke instans API Management.
Catatan
- Integrasi Azure API Management saat ini dalam pratinjau.
- Ada batasan jumlah instans API Management terintegrasi (sumber API).
- Pembaruan API di API Management biasanya disinkronkan ke pusat API Anda dalam hitungan menit, tetapi sinkronisasi dapat memakan waktu hingga 24 jam.
- Definisi API juga disinkronkan ke pusat API jika Anda memilih opsi untuk menyertakannya selama integrasi.
Entitas yang disinkronkan dari API Management
Anda dapat menambahkan atau memperbarui properti metadata dan dokumentasi ke API yang disinkronkan di pusat API Anda untuk membantu pemangku kepentingan menemukan, memahami, dan menggunakan API. Pelajari selengkapnya tentang properti metadata bawaan dan kustom Azure API Center.
Tabel berikut menunjukkan properti entitas yang dapat dimodifikasi di Azure API Center dan properti yang ditetapkan berdasarkan nilainya di sumber API.
| Entity | Properti yang dapat dikonfigurasi di API Center | Properti ditentukan dalam sumber API terintegrasi |
|---|---|---|
| API | ringkasan lifecycleStage termsOfService lisensi externalDocumentation customProperties |
title description jenis |
| versi API | lifecycleStage | title definisi (jika disinkronkan) |
| Lingkungan | title description kind server.managementPortalUri onboarding customProperties |
server.type |
| Penyebaran | title description server state customProperties |
server.runtimeUri |
Catatan
ID sumber daya dan sistem untuk entitas yang disinkronkan ke Azure API Center dibuat secara otomatis dan tidak dapat diubah.
Prasyarat
Pusat API di langganan Azure Anda. Jika Anda belum membuatnya, lihat Mulai Cepat: Membuat pusat API Anda.
Instans Azure API Management, dalam langganan yang sama atau berbeda. Instans harus berada di direktori yang sama.
Untuk Azure CLI:
Gunakan lingkungan Bash di Azure Cloud Shell. Untuk informasi selengkapnya, lihat Mulai Cepat untuk Bash di Azure Cloud Shell.
Jika Anda lebih suka menjalankan perintah referensi CLI secara lokal, instal Azure CLI. Jika Anda menjalankan Windows atau macOS, pertimbangkan untuk menjalankan Azure CLI dalam kontainer Docker. Untuk informasi lebih lanjut, lihat Cara menjalankan Azure CLI di kontainer Docker.
Jika Anda menggunakan instalasi lokal, masuk ke Azure CLI dengan menggunakan perintah login az. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Masuk dengan Azure CLI.
Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan ekstensi dengan Azure CLI.
Jalankan versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan peningkatan az.
Catatan
az apicperintah memerlukanapic-extensionekstensi Azure CLI. Jika Anda belum menggunakanaz apicperintah, ekstensi dapat diinstal secara dinamis saat Anda menjalankan perintah pertamaaz apic, atau Anda dapat menginstal ekstensi secara manual. Pelajari selengkapnya tentang ekstensi Azure CLI.Lihat catatan rilis untuk perubahan dan pembaruan terbaru di
apic-extension. Fitur tertentu mungkin memerlukan pratinjau atau versi ekstensi tertentu.Catatan
Contoh perintah Azure CLI dalam artikel ini dapat berjalan di PowerShell atau shell bash. Jika diperlukan karena sintaks variabel yang berbeda, contoh perintah terpisah disediakan untuk dua shell.
Mengaktifkan identitas terkelola di pusat API Anda
Untuk skenario ini, pusat API Anda menggunakan identitas terkelola untuk mengakses sumber daya Azure. Bergantung pada kebutuhan Anda, aktifkan identitas terkelola yang ditetapkan sistem atau satu atau beberapa identitas terkelola yang ditetapkan pengguna.
Contoh berikut menunjukkan cara mengaktifkan identitas terkelola yang ditetapkan sistem dengan menggunakan portal Azure atau Azure CLI. Pada tingkat tinggi, langkah-langkah konfigurasi serupa untuk identitas terkelola yang ditetapkan pengguna.
- Di portal, navigasikan ke pusat API Anda.
- Di menu sebelah kiri, di bawah Keamanan, pilih Identitas terkelola.
- Pilih Sistem yang ditetapkan, dan atur status ke Aktif.
- Pilih Simpan.
Menetapkan identitas terkelola peran Pembaca Layanan API Management
Untuk mengizinkan impor API, tetapkan identitas terkelola pusat API Anda peran API Management Service Reader dalam instans API Management Anda. Anda dapat menggunakan portal atau Azure CLI.
- Di portal, navigasikan ke instans API Management Anda.
- Di menu sebelah kiri, pilih Kontrol akses (IAM).
- Pilih + Tambahkan penetapan peran.
- Pada halaman Tambahkan penetapan peran, atur nilai sebagai berikut:
- Pada tab Peran , pilih Pembaca Layanan API Management.
- Pada tab Anggota, di Tetapkan akses ke - Pilih Identitas> terkelola+ Pilih anggota.
- Pada halaman Pilih identitas terkelola, pilih identitas terkelola yang ditetapkan sistem dari pusat API yang Anda tambahkan di bagian sebelumnya. Klik Pilih.
- Pilih Tinjau + tetapkan.
Mengintegrasikan instans API Management
Anda dapat mengintegrasikan instans API Management menggunakan portal atau Azure CLI.
- Di portal, navigasikan ke pusat API Anda.
- Di bawah Aset, pilih Lingkungan.
- Pilih Tautan (pratinjau)>+ Buat tautan.
- Di halaman Tautkan Layanan Azure API Management Anda:
- Pilih layanan Langganan, Grup sumber daya, dan Azure API Management yang ingin Anda integrasikan.
- Di Detail tautan, masukkan pengidentifikasi.
- Di Detail lingkungan, masukkan judul Lingkungan (nama), Jenis lingkungan, dan Deskripsi opsional.
- Dalam Detail API:
- Pilih Siklus Hidup untuk API yang disinkronkan. (Anda dapat memperbarui nilai ini untuk API setelah ditambahkan ke pusat API Anda.)
- Secara opsional, pilih apakah akan menyertakan definisi API dengan API yang disinkronkan.
- Pilih Buat.
Lingkungan ditambahkan di pusat API Anda. API Management API diimpor ke inventarisasi pusat API.
Menghapus integrasi
Saat sumber API terintegrasi, Anda tidak dapat menghapus API yang disinkronkan dari pusat API Anda. Jika perlu, Anda dapat menghapus integrasi. Saat Anda menghapus integrasi:
- API yang disinkronkan di inventarisasi pusat API Anda dihapus
- Lingkungan dan penyebaran yang terkait dengan sumber API dihapus
Anda dapat menghapus integrasi menggunakan portal atau Azure CLI.
- Di portal, navigasikan ke pusat API Anda.
- Di bawah Aset, pilih Tautan Lingkungan>(pratinjau).
- Pilih tautan, lalu pilih Hapus (ikon ke tempat sampah).