Menyambungkan secara privat ke API Management menggunakan titik akhir privat masuk
BERLAKU UNTUK: Pengembang | Dasar | Standar | Standar v2 | Premi
Anda dapat mengonfigurasi titik akhir privat masuk untuk instans API Management Anda untuk memungkinkan klien di jaringan privat Anda mengakses instans dengan aman melalui Azure Private Link.
Catatan
Dukungan titik akhir privat di tingkat Standar v2 saat ini dalam pratinjau terbatas. Untuk mendaftar, isi formulir ini.
Titik akhir privat menggunakan alamat IP dari jaringan virtual Azure tempat titik akhir dihosting.
Lalu lintas jaringan antara klien di jaringan privat Anda dan API Management melintasi jaringan virtual dan Private Link di jaringan backbone Microsoft, menghilangkan paparan dari internet publik.
Konfigurasikan pengaturan DNS kustom atau zona pribadi Azure DNS untuk memetakan nama host API Management ke alamat IP pribadi titik akhir.
Dengan titik akhir pribadi dan Private Link, Anda dapat:
Membuat beberapa koneksi Private Link ke instans API Management.
Menggunakan titik akhir pribadi untuk mengirim lalu lintas masuk pada koneksi aman.
Menggunakan kebijakan untuk membedakan lalu lintas yang berasal dari titik akhir pribadi.
Membatasi lalu lintas masuk hanya ke titik akhir pribadi, mencegah penyelundupan data.
Gabungkan titik akhir privat masuk ke instans Standard v2 dengan integrasi jaringan virtual keluar untuk menyediakan isolasi jaringan end-to-end klien API Management dan layanan backend Anda.
Penting
- Anda hanya dapat mengonfigurasi koneksi titik akhir privat untuk lalu lintas masuk ke instans API Management.
Batasan
- Hanya titik akhir Gateway instans API Management yang mendukung koneksi Private Link masuk.
- Setiap instans API Management mendukung paling banyak 100 koneksi Private Link.
- Koneksi tidak didukung di gateway yang dihost sendiri atau di gateway ruang kerja.
- Di tingkat API Management klasik, titik akhir privat tidak didukung dalam instans yang disuntikkan dalam jaringan virtual internal atau eksternal.
Prasyarat
- Instans API Management yang ada.
Buat jika Anda belum melakukannya.
- Saat menggunakan instans di tingkat Pengembang atau Premium klasik, jangan menyebarkan (menyuntikkan) instans ke jaringan virtual eksternal atau internal .
- Jaringan virtual yang berisi subnet untuk menghosting titik akhir privat. Subnet mungkin berisi sumber daya Azure lainnya.
- (Direkomendasikan) Mesin virtual di subnet yang sama atau berbeda di jaringan virtual, untuk menguji titik akhir pribadi.
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.
Metode persetujuan untuk titik akhir pribadi
Biasanya, administrator jaringan membuat titik akhir pribadi. Tergantung pada izin kontrol akses berbasis peran (RBAC) Azure Anda, titik akhir pribadi yang Anda buat disetujui secara otomatis untuk mengirim lalu lintas ke instans API Management, atau mengharuskan pemilik sumber daya untuk menyetujui secara manual sambungan tersebut.
Metode persetujuan | Izin RBAC minimum |
---|---|
Otomatis | Microsoft.Network/virtualNetworks/** Microsoft.Network/virtualNetworks/subnets/** Microsoft.Network/privateEndpoints/** Microsoft.Network/networkinterfaces/** Microsoft.Network/locations/availablePrivateEndpointTypes/read Microsoft.ApiManagement/service/** Microsoft.ApiManagement/service/privateEndpointConnections/** |
Manual | Microsoft.Network/virtualNetworks/** Microsoft.Network/virtualNetworks/subnets/** Microsoft.Network/privateEndpoints/** Microsoft.Network/networkinterfaces/** Microsoft.Network/locations/availablePrivateEndpointTypes/read |
Langkah-langkah untuk mengonfigurasi titik akhir pribadi
- Dapatkan jenis titik akhir pribadi yang tersedia dalam langganan
- Menonaktifkan kebijakan jaringan di subnet
- Buat titik akhir pribadi - portal
Dapatkan jenis titik akhir pribadi yang tersedia dalam langganan
Pastikan bahwa jenis titik akhir pribadi API Management tersedia di langganan dan lokasi Anda. Di portal, temukan informasi ini dengan membuka Pusat Private Link. Pilih Sumber daya yang didukung.
Anda juga dapat menemukan informasi ini dengan menggunakan Jenis Titik Akhir Pribadi yang Tersedia - Daftar REST API.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{region}/availablePrivateEndpointTypes?api-version=2021-03-01
Output harus menyertakan Microsoft.ApiManagement.service
jenis titik akhir:
[...]
"name": "Microsoft.ApiManagement.service",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/AvailablePrivateEndpointTypes/Microsoft.ApiManagement.service",
"type": "Microsoft.Network/AvailablePrivateEndpointTypes",
"resourceName": "Microsoft.ApiManagement/service",
"displayName": "Microsoft.ApiManagement/service",
"apiVersion": "2021-04-01-preview"
}
[...]
Menonaktifkan kebijakan jaringan di subnet
Kebijakan jaringan seperti grup keamanan jaringan harus dinonaktifkan di subnet yang digunakan untuk titik akhir pribadi.
Jika Anda menggunakan alat seperti Azure PowerShell, Azure CLI, atau REST API untuk mengonfigurasi titik akhir pribadi, perbarui konfigurasi subnet secara manual. Misalnya, lihat Mengelola kebijakan jaringan untuk titik akhir pribadi.
Saat Anda menggunakan portal Azure untuk membuat titik akhir privat, seperti yang ditunjukkan di bagian berikutnya, kebijakan jaringan dinonaktifkan secara otomatis sebagai bagian dari proses pembuatan.
Buat titik akhir pribadi - portal
Anda dapat membuat titik akhir privat untuk instans API Management Anda di portal Azure.
Di tingkat API Management klasik, Anda dapat membuat titik akhir privat saat membuat instans. Dalam instans yang ada, gunakan bilah Jaringan instans di portal Azure.
Navigasikan ke layanan API Management Anda di portal Microsoft Azure.
Di menu sebelah kiri, di bawah Penyebaran + infrastruktur, pilih Jaringan.
Pilih Koneksi> titik akhir privat masuk+ Tambahkan titik akhir.
Di tab Dasar dari Buat titik akhir pribadi, masukkan atau pilih informasi berikut:
Pengaturan Nilai Detail proyek Langganan Pilih langganan Anda. Grup sumber daya Pilih grup sumber daya yang sudah ada atau buat yang baru. Lokasinya harus berada di wilayah yang sama dengan jaringan virtual Anda. Detail instans Nama Masukkan nama untuk titik akhir seperti myPrivateEndpoint. Nama Antarmuka Jaringan Masukkan nama untuk antarmuka jaringan, seperti myInterface Wilayah Pilih lokasi untuk titik akhir pribadi. Lokasinya harus berada di wilayah yang sama dengan jaringan virtual Anda. Ini mungkin berbeda dari wilayah tempat instans API Management Anda di-hosting. Pilih tombol Berikutnya: Sumber Daya di bagian bawah layar. Informasi berikut tentang instans API Management Anda sudah diisi:
- Langganan
- Jenis Sumber Daya
- Nama sumber daya
Di Sumber Daya, di Sub-sumber daya Target, pilih Gateway.
Penting
Hanya sub-sumber daya Gateway yang didukung untuk API Management. Sub-sumber daya lain tidak didukung.
Pilih tombol Berikutnya: Jaringan Virtual di bagian bawah layar.
Di Virtual Network, masukkan atau pilih informasi ini:
Pengaturan Nilai Jaringan virtual Pilih jaringan virtual Anda. Subnet Pilih subnet Anda. Konfigurasi IP privat Dalam kebanyakan kasus, pilih Alokasikan alamat IP secara dinamis. Kelompok keamanan aplikasi Secara opsional pilih grup keamanan aplikasi. Pilih tombol Berikutnya: DNS di bagian bawah layar.
Di Integrasi DNS Privat, masukkan atau pilih informasi ini:
Pengaturan Nilai Integrasikan dengan zona DNS privat Biarkan default Ya. Langganan Pilih langganan Anda. Grup sumber daya Pilih grup sumber daya Anda. Zona DNS Private Nilai default ditampilkan: (baru) privatelink.azure-api.net. Pilih tombol Berikutnya: Tab di bagian bawah layar. Jika Anda mau, masukkan tag untuk mengatur sumber daya Azure Anda.
Pilih tombol Berikutnya: Tinjau + buat di bagian bawah layar. Pilih Buat.
Buat daftar koneksi titik akhir pribadi ke instans
Setelah titik akhir privat dibuat dan layanan diperbarui, titik akhir privat masuk muncul dalam daftar di halaman Koneksi titik akhir privat masuk instans API Management di portal.
Perhatikan Status koneksi titik akhir:
- Disetujui menunjukkan bahwa sumber daya API Management secara otomatis menyetujui sambungan.
- Tertunda menunjukkan bahwa sambungan harus disetujui secara manual oleh pemilik sumber daya.
Setujui koneksi titik akhir pribadi yang tertunda
Jika koneksi titik akhir pribadi dalam status tertunda, pemilik instans API Management harus menyetujuinya secara manual sebelum dapat digunakan.
Jika Anda memiliki izin yang memadai, setujui koneksi titik akhir pribadi di halaman Koneksi titik akhir pribadi instans API Management di portal. Di menu konteks koneksi (...), pilih Setujui.
Anda juga dapat menggunakan Api Management Private Endpoint Connection - Create Or Update REST API untuk menyetujui koneksi titik akhir privat yang tertunda.
Nonaktifkan akses jaringan publik secara opsional
Untuk membatasi lalu lintas masuk secara opsional ke instans API Management hanya ke titik akhir privat, nonaktifkan properti akses jaringan publik.
Catatan
Akses jaringan publik hanya dapat dinonaktifkan dalam instans API Management yang dikonfigurasi dengan titik akhir privat, bukan dengan konfigurasi jaringan lainnya.
Untuk menonaktifkan properti akses jaringan publik menggunakan Azure CLI, jalankan perintah az apim update berikut, ganti nama instans API Management dan grup sumber daya Anda:
az apim update --name my-apim-service --resource-group my-resource-group --public-network-access false
Anda juga dapat menggunakan API Management Service - Update REST API untuk menonaktifkan akses jaringan publik, dengan mengatur publicNetworkAccess
properti ke Disabled
.
Memvalidasi koneksi titik akhir pribadi
Setelah titik akhir pribadi dibuat, konfirmasikan pengaturan DNS-nya di portal:
Navigasikan ke layanan API Management Anda di portal Microsoft Azure.
Di menu sebelah kiri, di bawah Penyebaran + infrastruktur, pilih Koneksi titik akhir privat Masuk Jaringan>, dan pilih titik akhir privat yang Anda buat.
Di navigasi sebelah kiri, di bawah Pengaturan, pilih Konfigurasi DNS.
Tinjau catatan DNS dan alamat IP dari titik akhir pribadi. Alamat IP adalah alamat pribadi di ruang alamat subnet tempat titik akhir pribadi dikonfigurasi.
Uji di jaringan virtual
Hubungkan ke mesin virtual yang Anda siapkan di jaringan virtual.
Jalankan utilitas seperti nslookup
atau dig
untuk mencari alamat IP titik akhir Gateway default Anda melalui Private Link. Contohnya:
nslookup my-apim-service.privatelink.azure-api.net
Output harus menyertakan alamat IP pribadi yang terkait dengan titik akhir pribadi.
Panggilan API yang dimulai dalam jaringan virtual ke titik akhir Gateway default akan berhasil.
Pengujian dari internet
Dari luar jalur titik akhir pribadi, coba panggil titik akhir Gateway default instans API Management. Jika akses publik dinonaktifkan, output menyertakan kesalahan dengan kode 403
status dan pesan yang mirip dengan:
Request originated from client public IP address 192.0.2.12, public network access on this 'Microsoft.ApiManagement/service/my-apim-service' is disabled.
To connect to 'Microsoft.ApiManagement/service/my-apim-service', please use the Private Endpoint from inside your virtual network.
Konten terkait
- Gunakan ekspresi kebijakan dengan variabel
context.request
untuk mengidentifikasi lalu lintas dari titik akhir pribadi. - Pelajari selengkapnya tentang titik akhir privat dan Private Link, termasuk harga Private Link.
- Mengelola koneksi titik akhir privat.
- Memecahkan masalah konektivitas titik akhir pribadi Azure.
- Gunakan templat Resource Manager untuk membuat instans API Management klasik dan titik akhir privat dengan integrasi DNS privat.
- Sambungkan Azure Front Door Premium ke Azure API Management dengan Private Link (Pratinjau).