Referensi REST API Manajemen (Search Azure AI)

  • Artikel

REST API Manajemen azure AI Search (sebelumnya dikenal sebagai Azure Cognitive Search) menyediakan akses terprogram ke operasi administratif:

  • Membuat, memperbarui, dan menghapus layanan pencarian
  • Mengambil informasi 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
  • Mengaktifkan atau menonaktifkan kontrol akses berbasis peran Azure

Untuk tugas data plane, seperti membuat dan mengkueri indeks, gunakan SEARCH Service REST API sebagai gantinya.

Cara bekerja dengan REST API manajemen

Untuk sepenuhnya mengelola layanan Anda secara terprogram, Anda bekerja dengan dua API: REST API Manajemen azure AI Search didokumentasikan di sini, ditambah Azure Resource Manager REST API umum.

API Resource Manager digunakan untuk operasi tujuan umum yang tidak spesifik untuk layanan, seperti mengkueri data langganan, mencantumkan lokasi geografis, dan sebagainya. Semua panggilan API Resource Manager diautentikasi menggunakan Microsoft Entra ID. Anda harus memiliki keanggotaan dan penetapan peran di penyewa Microsoft Entra untuk melakukan panggilan API Resource Manager.

Dokumen API versi

Dokumen REST API sekarang diberi versi. Saat Anda membuka halaman referensi API, pilih versi API dari filter dropdown.

Cuplikan layar pemilih versi.

Izin dan kontrol akses

Hak administrasi disampaikan melalui peran bawaan dalam Microsoft Entra ID:

  • Penetapan Pemilik atau Kontributor diperlukan untuk sebagian besar tugas.
  • Peran pembaca memiliki akses terbatas ke informasi layanan (operasi GET, kecuali untuk kunci API, yang memerlukan izin Pemilik atau Kontributor).

Untuk informasi selengkapnya, lihat Kontrol akses berbasis peran di Azure AI Search.

Praktik terbaik adalah menetapkan peran ke grup daripada pengguna individual. Pemilik langganan Azure atau administrator global mengelola tugas ini. Untuk informasi selengkapnya, lihat Menetapkan peran Microsoft Entra ke grup.

Menyambungkan ke titik akhir manajemen

Saat menyiapkan koneksi, mulailah dengan titik https://management.azure.com akhir Resource Manager lalu tambahkan 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:

Klien Instruksi dan contoh
Azure PowerShell menggunakan modul Az.Search Mengelola Search Azure AI menggunakan Azure PowerShell
Antarmuka Baris Perintah (CLI) Azure Mengelola azure AI Search menggunakan Azure CLI
Visual Studio Code dengan klien REST Mengelola Search Azure AI menggunakan REST

Anda juga dapat mengelola layanan pencarian menggunakan portal Azure.

API Manajemen di SDK lain

REST API bersifat dasar untuk azure AI 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:

Lihat juga