Megosztás a következőn keresztül:


Felügyeleti REST API-referencia (Azure AI Search)

Az Azure AI Search (korábbi nevén Azure Cognitive Search) felügyeleti REST API-i programozott hozzáférést biztosítanak a felügyeleti műveletekhez:

  • Keresési szolgáltatás létrehozása, frissítése és törlése
  • Keresési szolgáltatás adatainak lekérése
  • Létrehozás, újragenerálás vagy lekérés api-keys (lekérdezési vagy rendszergazdai kulcsok)
  • Replikák és partíciók hozzáadása vagy eltávolítása (kapacitás beállítása)
  • Keresési szolgáltatás konfigurálása privát végpont használatára
  • Az Azure szerepköralapú hozzáférés-vezérlés engedélyezése vagy letiltása

Az adatsík feladataihoz, például az index létrehozásához és lekérdezéséhez használja a Search Service REST API-kat .

A felügyeleti REST API-k használata

A szolgáltatás programozott felügyeletéhez két API-val kell dolgoznia: az itt dokumentált Azure AI Search felügyeleti REST API-jával, valamint a közös Azure Resource Manager REST API-val.

A Resource Manager API olyan általános célú műveletekhez használható, amelyek nem szolgáltatásspecifikusak, például előfizetési adatok lekérdezése, földrajzi helyek listázása stb. Az összes Resource Manager API-hívás hitelesítése Microsoft Entra azonosítóval történik. A Resource Manager API-hívások kezdeményezéséhez tagsággal és szerepkör-hozzárendeléssel kell rendelkeznie egy Microsoft Entra-bérlőben.

Verziószámozott API-dokumentumok

A REST API dokumentumok verziószámmal vannak ellátva. Amikor megnyit egy API-referencialapot, válassza ki az API-verziót a legördülő szűrőből.

A verzióválasztó képernyőképe.

Engedélyek és hozzáférés-vezérlés

A rendszergazdai jogosultságokat a Microsoft Entra ID beépített szerepkörei közvetítik:

  • A legtöbb feladathoz tulajdonosi vagy közreműködői hozzárendelés szükséges.
  • Az olvasói szerepkör korlátozott hozzáféréssel rendelkezik a szolgáltatásinformációkhoz (GET műveletekhez, kivéve az API-kulcsokat, amelyekhez tulajdonosi vagy közreműködői engedélyek szükségesek).

További információ: Szerepköralapú hozzáférés-vezérlés az Azure AI Searchben.

Ajánlott a szerepkörök csoportokhoz való hozzárendelése az egyes felhasználók helyett. Ezeket a hozzárendeléseket egy Azure-előfizetés tulajdonosa vagy globális rendszergazdája kezeli. További információ: Microsoft Entra-szerepkörök hozzárendelése csoportokhoz.

Csatlakozás a felügyeleti végponthoz

A kapcsolat beállításakor kezdje a Resource Manager végponttal https://management.azure.com , majd adja hozzá az előfizetés azonosítóját, a szolgáltatót ()Microsoft.Search és az API-verziót. A műveleteket a kérelem törzse határozza meg.

A teljesen megadott végpont a következő összetevőket tartalmazza:

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

A felügyeleti REST API-k hívására gyakran a következő ügyfeleket használják:

Ügyfél Utasítások és példák
Azure PowerShell az Az.Search modul használatával Azure AI Search kezelése a Azure PowerShell
Azure Command-Line felület (CLI) Az Azure AI Search kezelése az Azure CLI használatával
Visual Studio Code a REST-ügyféllel Azure AI Search kezelése REST használatával

A keresési szolgáltatásokat a Azure Portal használatával is kezelheti.

Felügyeleti API-k más SDK-kban

A REST API-k az Azure AI Search alapját képezik, és a programozási modell módosításai először a REST API-kban jelennek meg.

Az alternatívák közé tartoznak a következő Azure SDK-k, amelyek egymástól függetlenül frissülnek külön kiadási ütemezések szerint:

Lásd még