Aracılığıyla paylaş

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

Azure AI Search'ün 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ğaltma ve bölüm 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 Hizmeti REST API'lerini kullanın.

Yönetim REST API'leri ile çalışma

Hizmetinizi program aracılığıyla tam olarak yönetmek için iki API ile çalışırsınız: burada belgelenen Azure AI Search'ün Yönetim REST API'si ve ortak Azure Resource Manager REST API'si.

Resource Manager API'si, abonelik verilerini sorgulama, coğrafi konumları listeleme vb. 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 Kimliği kullanılarak doğrulanır. Resource Manager API çağrıları yapmak için bir Microsoft Entra kiracısında üyeliğiniz ve rol atamanız olmalıdır.

Sürüme alınan API belgeleri

REST API belgelerinin sürümü oluşturulur. 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'deki 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 (Sahip veya Katkıda Bulunan izinleri gerektiren API anahtarları dışında GET işlemleri) sınırlı erişimi vardır.

Daha fazla bilgi için Azure AI Search'te rol tabanlı erişim denetimine bakın.

En iyi uygulama, rolleri tek tek kullanıcılar yerine gruplara atamaktır. Bu atamaları bir Azure aboneliği sahibi veya genel yönetici yönetir. Daha fazla bilgi için Microsoft Entra rollerini gruplara atamakonusuna bakın.

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 bir 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

Aşağıdaki istemciler genellikle yönetim REST API'lerini çağırmak için kullanılır:

Müşteri Talimatlar ve örnekler
Az.Search modülünü kullanarak Azure PowerShell Azure PowerShell kullanarak Azure AI Search'ü yönetme
Azure Command-Line Arabirimi (CLI) Azure CLI'yi kullanarak Azure AI Search'ü yönetme
REST istemcisiyle Visual Studio Code REST kullanarak Azure AI Search'ü yönetme

Azure portal kullanarak bir arama hizmetini de yönetebilirsiniz.

Diğer SDK'lardaki yönetim API'leri

REST API'leri Azure AI Search için temel oluşturur ve programlama modelinde yapılan tüm değişiklikler önce REST API'lerine yansıtılır.

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

Ayrıca bakınız

  • Last updated on