Menyinkronkan API dari Amazon API Gateway ke Azure API Center (pratinjau)

Artikel ini memperlihatkan cara mengintegrasikan Amazon API Gateway sehingga API gateway terus diperbarui dalam inventarisasi pusat API Anda.

Tentang mengintegrasikan Amazon API Gateway

Mengintegrasikan Amazon API Gateway sebagai sumber API untuk pusat API Anda memungkinkan sinkronisasi berkelanjutan sehingga inventarisasi API tetap terbaru. Azure API Center juga dapat menyinkronkan API dari sumber termasuk Azure API Management.

Saat Anda mengintegrasikan Amazon API Gateway sebagai sumber API, hal berikut ini terjadi:

1. API, dan definisi API opsional (spesifikasi), dari API Gateway ditambahkan ke inventarisasi pusat API.
2. Anda mengonfigurasi lingkungan jenis Amazon API Gateway di pusat API.
3. Sebuah penyebaran terkait dibuat untuk setiap definisi API yang disinkronkan.

Sinkronisasi adalah satu arah dari Amazon API Gateway ke pusat API Azure Anda, yang berarti pembaruan API di pusat API tidak disinkronkan kembali ke Amazon API Gateway.

Catatan

• Integrasi Amazon API Gateway saat ini berada dalam tahap pratinjau.
• Ada batasan jumlah sumber API terintegrasi.
• API di Amazon API Gateway disinkronkan ke pusat API Anda sekali per jam. Hanya REST API yang disinkronkan.
• Definisi API juga disinkronkan ke pusat API jika Anda memilih opsi untuk menyertakannya selama integrasi. Hanya definisi dari API yang disebarkan yang disinkronkan.

Entitas yang disinkronkan dari Amazon API Gateway

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.

Entitas	Properti yang dapat dikonfigurasi di API Center	Properti ditentukan dalam sumber API terintegrasi
API	ringkasan tahap siklus hidup ketentuan layanan lisensi Dokumentasi Eksternal customProperties	judul deskripsi jenis
versi API	tahap siklus hidup	judul definisi (jika disinkronkan)
Lingkungan	judul deskripsi jenis server.managementPortalUri onboarding customProperties	server.tipe
Penyebaran	judul deskripsi server negara (or provinsi/negara bagian, depending on context) 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 Panduan Cepat: Membuat Pusat API Anda.

• Brankas kunci Azure. Jika Anda perlu membuatnya, lihat Mulai Cepat: Membuat brankas kunci menggunakan portal Azure. Untuk menambahkan atau mengelola rahasia di gudang kunci, setidaknya diperlukan peran Petugas Rahasia Key Vault atau izin yang setara.

• Sebuah Amazon API Gateway.

• Identitas pengguna AWS IAM dengan sebuah kebijakan yang AmazonAPIGatewayAdministrator dilampirkan.

• 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 login az. 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 versi az untuk menemukan versi dan pustaka dependen yang diinstal. Untuk meningkatkan ke versi terbaru, jalankan az upgrade.

  Catatan

  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.

  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.

Membuat kunci akses pengguna IAM

Untuk mengautentikasi pusat API Anda ke Amazon API Gateway, Anda memerlukan kunci akses untuk pengguna AWS IAM.

Untuk menghasilkan ID kunci akses dan kunci rahasia yang diperlukan menggunakan AWS Management Console, lihat Membuat kunci akses untuk diri Anda sendiri dalam dokumentasi AWS.

Simpan kunci akses Anda di lokasi yang aman. Anda akan menyimpannya di Azure Key Vault di langkah berikutnya.

Perhatian

Kunci akses adalah kredensial jangka panjang, dan Anda harus mengelolanya dengan aman seperti kata sandi. Pelajari selengkapnya tentang mengamankan kunci akses

Menyimpan kunci akses pengguna IAM di Azure Key Vault

Unggah dan simpan dua kunci akses pengguna IAM dengan aman di Azure Key Vault menggunakan konfigurasi yang direkomendasikan dalam tabel berikut. Untuk informasi selengkapnya, lihat Mulai Cepat: Mengatur dan mengambil rahasia dari Azure Key Vault menggunakan portal Azure.

Rahasia AWS	Opsi pengunggahan	Nama	Nilai rahasia
Kunci akses	Panduan	aws-access-key	ID kunci akses yang diambil dari AWS
Kunci akses rahasia	Panduan	aws-secret-access-key	Kunci akses rahasia yang diambil dari AWS

Perhatikan pengidentifikasi rahasia dari setiap rahasia, URI yang mirip dengan https://<key-vault-name>.vault.azure.net/secrets/<secret-name>. Anda akan menggunakan pengidentifikasi ini di langkah berikutnya.

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

1. Di portal, navigasikan ke pusat API Anda.
2. Di menu sebelah kiri, di bawah Keamanan, pilih Identitas terkelola.
3. Pilih Sistem yang ditetapkan, dan atur status ke Aktif.
4. Pilih Simpan.

Azure CLI

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"}'

Menetapkan identitas terkelola sebagai peran Pengguna Rahasia Key Vault

Untuk mengizinkan impor API, tetapkan identitas terkelola pusat API Anda ke peran Pengguna Rahasia Key Vault di brankas kunci Azure Anda. Anda dapat menggunakan portal atau Azure CLI.

Portal

1. Di portal, navigasikan ke brankas kunci Anda.
2. Di menu sebelah kiri, pilih Kontrol akses (IAM).
3. Pilih + Tambahkan penetapan peran.
4. Pada halaman Tambahkan penetapan peran, atur nilai sebagai berikut:
   1. Pada tab Peran, pilih Pengguna Rahasia di Key Vault.
   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.

Azure CLI

1. Dapatkan ID utama 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)
   

2. Dapatkan ID sumber daya dari brankas kunci Anda menggunakan perintah az keyvault show.

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

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

3. Tetapkan peran Pengguna Rahasia Key Vault pada identitas terkelola di brankas kunci Anda menggunakan perintah az role assignment create.

   #! /bin/bash
   scope="${kvID:1}"
   
   az role assignment create \
       --role "Key Vault Secrets User" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "Key Vault Secrets User" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

Mengintegrasikan Amazon API Gateway

Anda dapat mengintegrasikan Amazon API Gateway menggunakan portal atau Azure CLI.

Portal

1. Di portal, navigasikan ke pusat API Anda.
2. Di bawah Platform, pilih Integrasi.
3. Pilih + Integrasi Baru>Dari Amazon API Gateway.
4. Di halaman Integrasikan Amazon API Gateway Service Anda :
   1. Untuk kunci akses AWS dan kunci akses rahasia AWS, klik Pilih dan pilih langganan, brankas kunci, rahasia yang Anda simpan.
   2. Pilih wilayah AWS tempat Amazon API Gateway disebarkan.
   3. Di Detail integrasi, masukkan pengidentifikasi.
   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.
5. Pilih Buat.

Azure CLI

Jalankan perintah az apic integration create aws (pratinjau) untuk mengintegrasikan Amazon API Gateway ke pusat API Anda.

• Berikan nama grup sumber daya, pusat API, dan integrasi.

• Berikan pengidentifikasi rahasia di Key Vault untuk kunci akses AWS dan kunci akses rahasia AWS, serta wilayah AWS tempat Amazon API Gateway diluncurkan.

az apic integration create aws \
    --resource-group <resource-group-name> \
    --service-name-name <api-center-name> \
    --integration-name <aws-integration-name> \
    --aws-access-key-reference <access-key-uri> \
    --aws-secret-access-key-reference <secret-access-key-uri> 
    --aws-region-name <aws-region>

Lingkungannya ditambahkan ke pusat API Anda. API Amazon API Gateway diimpor ke inventarisasi pusat API.

Hapus 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

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

Azure CLI

Jalankan perintah az apic integration delete (pratinjau) 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> \

Konten terkait

• Mengelola inventori API dengan perintah Azure CLI
• Menyinkronkan API dari API Management ke pusat Azure API Anda