Yönetim REST API başvurusu (Azure AI Arama)

  • Makale

Azure AI Arama Yönetim REST API'leri (eski adıyla Azure Bilişsel Arama) yönetim işlemlerine programlı erişim sağlar:

  • Arama hizmeti oluşturma, güncelleştirme ve silme
  • Arama hizmeti bilgilerini alma
  • Oluşturma, yeniden oluşturma veya alma api-keys (sorgu veya yönetici anahtarları)
  • Çoğaltmaları ve bölümleri ekleme veya kaldırma (kapasiteyi ayarlama)
  • Arama hizmetini özel uç nokta kullanacak şekilde yapılandırma
  • Azure rol tabanlı erişim denetimini etkinleştirme veya devre dışı bırakma

Dizin oluşturma ve sorgulama gibi veri düzlemi görevleri için bunun yerine Arama Service REST API'lerini kullanın.

Yönetim REST API'leriyle çalışma

Hizmetinizi program aracılığıyla tam olarak yönetmek için iki API ile çalışırsınız: Burada belgelenen Azure AI Arama Yönetim REST API'sinin yanı sıra yaygın Azure Resource Manager REST API'siyle.

Resource Manager API'si abonelik verilerini sorgulama, coğrafi konumları listeleme gibi hizmete özgü olmayan genel amaçlı işlemler için kullanılır. Tüm Resource Manager API çağrılarının kimliği Microsoft Entra ID kullanılarak doğrulanır. Resource Manager API çağrıları yapmak için Microsoft Entra kiracısında üyeliğiniz ve rol atamanız olmalıdır.

Sürüme alınan API belgeleri

REST API belgeleri artık sürümlenmiştir. BIR API başvuru sayfasını açtığınızda, açılan filtreden API sürümünü seçin.

Sürüm seçicinin ekran görüntüsü.

İzinler ve erişim denetimi

Yönetim hakları, Microsoft Entra ID'daki yerleşik roller aracılığıyla iletilir:

  • Çoğu görev için sahip veya Katkıda Bulunan atamaları gereklidir.
  • Okuyucu rolünün hizmet bilgilerine sınırlı erişimi vardır (Sahip veya Katkıda Bulunan izinleri gerektiren API anahtarları dışında GET işlemleri).

Daha fazla bilgi için bkz. Azure AI Arama rol tabanlı erişim denetimi.

En iyi yöntemlerden biri, tek tek kullanıcılar yerine gruplara rol atamaktır. Bu atamaları bir Azure aboneliği sahibi veya genel yönetici yönetir. Daha fazla bilgi için bkz. Gruplara Microsoft Entra rolleri atama.

Yönetim uç noktasına bağlanma

Bağlantıyı ayarlarken Resource Manager uç noktasıyla https://management.azure.com başlayın ve ardından abonelik kimliğini, sağlayıcıyı (Microsoft.Search) ve API sürümünü ekleyin. İşlemler isteğin gövdesinde belirtilir.

Tam olarak belirtilen uç nokta aşağıdaki bileşenlere sahiptir:

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

Yönetim REST API'lerini çağırmak için yaygın olarak aşağıdaki istemciler kullanılır:

İstemci Yönergeler ve örnekler
Az.Arama modülünü kullanarak Azure PowerShell azure yapay zeka Arama Azure PowerShell kullanarak yönetme
Azure Komut Satırı Arabirimi (CLI) Azure CLI kullanarak Azure yapay zeka Arama yönetme
REST istemcisiyleVisual Studio Code REST kullanarak Azure AI Arama yönetme

Arama hizmetini Azure portal kullanarak da yönetebilirsiniz.

Diğer SDK'larda Yönetim API'leri

REST API'leri, Azure AI Arama'nin temelini oluşturur ve programlama modelindeki değişiklikler önce REST API'lerine yansıtılır.

Alternatifler, ayrı sürüm zamanlamalarında bağımsız olarak güncelleştirilen aşağıdaki Azure SDK'larını içerir:

Ayrıca bkz.