Search Management
REST API Manajemen Azure Cognitive Search menyediakan akses terprogram ke operasi administratif:
- Membuat atau menghapus layanan pencarian
- Membuat, meregenerasi, atau mengambil
api-keys
(kunci kueri atau admin) - Menambahkan atau menghapus replika dan partisi (menyesuaikan kapasitas)
- Mengonfigurasi layanan pencarian untuk menggunakan titik akhir privat
Untuk semua tugas lain, seperti membuat dan mengkueri indeks, gunakan REST API Layanan Pencarian sebagai gantinya.
Untuk sepenuhnya mengelola layanan Anda secara terprogram, Anda memerlukan dua API: REST API Manajemen Azure Cognitive Search yang didokumentasikan di sini, ditambah Azure Resource Manager REST API umum. API Resource Manager digunakan untuk operasi tujuan umum yang tidak spesifik layanan, seperti mengkueri data langganan, mencantumkan lokasi geografis, dan sebagainya.
Koneksi ke titik akhir manajemen
Saat menyiapkan koneksi, mulailah dengan titik https://management.azure.com
akhir Resource Manager . Permintaan HTTP mencakup titik akhir Resource Manager, ID langganan, penyedia (Microsoft.Search
), dan versi API. Operasi ditentukan dalam isi permintaan.
Titik akhir yang sepenuhnya ditentukan memiliki komponen berikut:
https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2020-08-01
Klien berikut umumnya digunakan untuk memanggil REST API manajemen:
- Azure PowerShell menggunakan modul Az.Search PowerShell (diperbarui pada jadwal terpisah dan tidak dijamin memiliki peningkatan)
- Antarmuka Baris Perintah (CLI) Azure
- Postman atau alat pengujian API web lainnya
Anda juga dapat menggunakan portal Azure.
Autentikasi dan kontrol akses
Hak administrasi disampaikan melalui peran dalam Azure Active Directory (AD). Praktik terbaik adalah menetapkan peran ke grup daripada pengguna individual. Pemilik langganan atau administrator global mengelola penugasan ini. Untuk informasi selengkapnya, lihat Menetapkan peran Azure AD ke grup.
Untuk manajemen layanan pencarian, peran yang didukung termasuk Pemilik, Kontributor, dan Pembaca. Untuk daftar lengkapnya, lihat Otorisasi berbasis peran.
API Manajemen di SDK lain
REST API bersifat dasar untuk Azure Cognitive Search, dan setiap perubahan pada model pemrograman tercermin dalam REST API terlebih dahulu.
Alternatifnya termasuk Azure SDK berikut, yang diperbarui secara independen pada jadwal rilis terpisah: