Bagikan melalui

Referensi REST API manajemen (Azure AI Search)

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, membuat ulang, atau mengambil api-keys (kunci kueri atau admin)
  • Tambahkan atau hapus replika dan partisi (sesuaikan kapasitas)
  • Mengonfigurasi layanan pencarian untuk menggunakan titik akhir privat
  • Mengaktifkan atau menonaktifkan kontrol akses berbasis peran Azure

Untuk tugas sarana data, seperti membuat dan mengkueri indeks, gunakan REST API Search Service.

Cara bekerja dengan REST API manajemen

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

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

Dokumen API versi

Dokumen REST API memiliki 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 di 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, bukan pengguna individu. Pemilik langganan Azure atau administrator global mengelola penetapan ini. Untuk informasi selengkapnya, lihat Menetapkan peran Microsoft Entra ke grup.

Menyambungkan ke titik akhir manajemen

Saat menyiapkan koneksi, mulai dengan titik akhir https://management.azure.com Resource Manager, lalu tambahkan ID langganan, penyedia (Microsoft.Search), dan versi API. Operasi ditentukan dalam isi permintaan.

Titik akhir yang ditentukan sepenuhnya memiliki komponen berikut:

https://management.azure.com/subscriptions/[subscriptionId]/resourceGroups/[resourceGroupName]/providers/Microsoft.Search/searchServices/[serviceName]?api-version=2020-08-01

Klien berikut biasanya digunakan untuk memanggil REST API manajemen:

Klien Instruksi dan contoh
Azure PowerShell menggunakan modul Az.Search Mengelola Azure AI Search menggunakan Azure PowerShell
Azure Command-Line Interface (CLI) Mengelola Azure AI Search menggunakan Azure CLI
Visual Studio Code dengan klien REST Mengelola Azure AI Search menggunakan REST

Anda juga dapat mengelola layanan pencarian menggunakan portal Microsoft Azure.

API Manajemen di SDK lain

REST API adalah dasar untuk Azure AI Search, dan setiap perubahan pada model pemrograman tercermin dalam REST API terlebih dahulu.

Alternatif mencakup Azure SDK berikut, yang diperbarui secara independen pada jadwal rilis terpisah:

Lihat juga

  • Last updated on