Menyinkronkan API dari instans API Management

Artikel ini menunjukkan cara mengintegrasikan instans API Management sehingga API instans terus diperbarui di inventarisasi pusat API Anda.

Tip

Artikel ini menjelaskan cara mengintegrasikan instans API Management dari pusat API Anda. Atau, siapkan integrasi dengan cepat langsung dari instans API Management. Di menu sebelah kiri instans Anda, di bawah API, pilih PUSAT API, dan pilih pusat API target di langganan Anda untuk menyinkronkan API.

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. Server MCP dalam API Management disertakan dalam API yang ditambahkan ke inventarisasi.
Anda mengonfigurasi lingkungan jenis Azure API Management di pusat API.
Penyebaran terkait dibuat untuk setiap definisi API yang telah disinkronkan dari sistem manajemen API.

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.

Note

Ada batasan jumlah instans API Management terintegrasi (sumber API).
Instans API Management terintegrasi dapat dikonfigurasi dalam jaringan virtual.
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	summary lifecycleStage termsOfService lisensi externalDocumentation customProperties	title description kind
Versi API	lifecycleStage	title definisi (jika disinkronkan)
Environment	title description kind server.managementPortalUri onboarding customProperties	server.type
Deployment	title description server state customProperties	server.runtimeUri

Note

ID sumber daya dan sistem untuk entitas yang disinkronkan ke Azure API Center dibuat secara otomatis dan tidak dapat diubah.

Prerequisites

Pusat API di langganan Azure Anda. Jika Anda belum membuatnya, lihat Panduan Memulai: 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 menggunakan 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 az login. Untuk menyelesaikan proses autentikasi, ikuti langkah-langkah yang ditampilkan di terminal Anda. Untuk opsi masuk lainnya, lihat Mengautentikasi ke Azure menggunakan Azure CLI.
  - Saat Anda diminta, instal ekstensi Azure CLI pada penggunaan pertama. Untuk informasi selengkapnya tentang ekstensi, lihat Menggunakan dan mengelola ekstensi dengan Azure CLI.
  - Jalankan az version untuk menemukan versi dan pustaka dependen yang terinstal. Untuk meng-upgrade ke versi terbaru, jalankan az upgrade.
Note

az apic perintah memerlukan apic-extension ekstensi Azure CLI. Jika Anda belum menggunakan az apic perintah, ekstensi dapat diinstal secara dinamis saat Anda menjalankan perintah pertama az 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.

Note

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.

Portal
Azure CLI

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.

Atur identitas yang ditetapkan sistem di pusat API Anda menggunakan perintah az apic update berikut. Ganti nama pusat API dan grup sumber daya Anda:

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

Tugaskan identitas terkelola ke peran Pembaca Layanan API Management

Untuk mengizinkan impor API, tetapkan identitas terkelola pusat API Anda dengan peran API Management Service Reader dalam instans API Management Anda. Anda dapat menggunakan portal atau Azure CLI.

Portal
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:
1. Pada tab Peran , pilih Pembaca Layanan API Management.
2. Pada tab Anggota, di Tetapkan akses ke - Pilih Identitas> terkelola+ Pilih anggota.
3. Pada halaman Pilih identitas terkelola, pilih identitas terkelola yang ditetapkan sistem dari pusat API yang Anda tambahkan di bagian sebelumnya. Klik Pilih.
4. Pilih Tinjau + tetapkan tugas.

Dapatkan ID induk identitas. Untuk identitas yang ditetapkan sistem, gunakan perintah az apic show .

#! /bin/bash
apicObjID=$(az apic show --name <api-center-name> \
    --resource-group <resource-group-name> \
    --query "identity.principalId" --output tsv)

# Formatted for PowerShell
$apicObjID=$(az apic show --name <api-center-name> `
    --resource-group <resource-group-name> `
    --query "identity.principalId" --output tsv)

Dapatkan resource ID dari instans API Management Anda menggunakan perintah az apim show.

#! /bin/bash
apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)

# Formatted for PowerShell
$apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)

Tetapkan identitas terkelola dengan peran API Management Service Reader dalam instans API Management Anda menggunakan perintah az role assignment create.

#! /bin/bash
scope="${apimID:1}"

az role assignment create \
    --role "API Management Service Reader Role" \
    --assignee-object-id $apicObjID \
    --assignee-principal-type ServicePrincipal \
    --scope $scope

# Formatted for PowerShell
$scope=$apimID.substring(1)

az role assignment create `
    --role "API Management Service Reader Role" `
    --assignee-object-id $apicObjID `
    --assignee-principal-type ServicePrincipal `
    --scope $scope

Mengintegrasikan instans API Management

Anda dapat mengintegrasikan instans API Management menggunakan portal atau Azure CLI.

Portal
Azure CLI

Di portal, navigasikan ke pusat API Anda.
Di bawah Platform, pilih Integrasi.
Pilih + Integrasi Baru>dari Azure API Management.
Di halaman Integrasikan Azure API Management Service Anda :
1. Pilih apakah akan menyinkronkan semua API dari instans API Management atau hanya API yang berada di ruang kerja API Management.
2. Pilih layanan Langganan, Grup sumber daya, dan Azure API Management yang ingin Anda integrasikan. Jika Anda hanya ingin menyinkronkan API dari ruang kerja, buat pilihan di Pilih ruang kerja.
3. Di Detail integrasi, masukkan pengidentifikasi. Jika Anda belum mengonfigurasi identitas terkelola dengan akses ke instans API Management, aktifkan Konfigurasi identitas terkelola secara otomatis dan tetapkan izin. Pilihan ini secara otomatis memberikan izin yang diperlukan kepada identitas terkelola yang ditetapkan oleh sistem pusat API, untuk menyinkronkan API dari instans API Management.
4. Di Detail lingkungan, masukkan judul Lingkungan (nama), Jenis lingkungan, dan Deskripsi opsional.
5. Dalam Detail API:
  1. Pilih Siklus Hidup untuk API yang disinkronkan. (Anda dapat memperbarui nilai ini untuk API setelah ditambahkan ke pusat API Anda.)
  2. Secara opsional, pilih apakah akan menyertakan definisi API dengan API yang disinkronkan.
Pilih Buat.

Cuplikan layar mengintegrasikan layanan Azure API Management di portal.

Jalankan perintah az apic integration create apim untuk mengintegrasikan instans API Management ke pusat API Anda.

Berikan nama grup sumber daya, pusat API, dan integrasi.
Jika instans API Management dan pusat API berada dalam grup sumber daya yang sama, Anda dapat memberikan nama instans API Management sebagai nilai azure-apim; jika tidak, berikan ID sumber daya Azure.

az apic integration create apim \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <apim-integration-name> \
    --azure-apim <apim-instance-name>

Instans API Management terintegrasi sebagai lingkungan di pusat API Anda. API Management API disinkronkan 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.

Portal
Azure CLI

Di portal, navigasikan ke pusat API Anda.
Di bawah Aset, pilih Lingkungan>Integrasi (pratinjau).
Pilih integrasi, lalu pilih Hapus (ikon tempat sampah).

Jalankan perintah pratinjau az apic integration delete untuk menghapus integrasi. Berikan nama grup sumber daya, pusat API, dan integrasi.

az apic integration delete \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <integration-name> \

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2025-10-15