Felügyeleti REST API-referencia (Azure AI-Keresés)

  • Cikk

Az Azure AI-Keresés (korábbi nevén Azure Cognitive Search) felügyeleti REST API-k 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 módosítása)
  • Keresési szolgáltatás konfigurálása privát végpont használatára
  • Azure szerepköralapú hozzáférés-vezérlés engedélyezése vagy letiltása

Adatsík-feladatokhoz, például index létrehozásához és lekérdezéséhez használja inkább a Keresés Service REST API-kat.

A felügyeleti REST API-k használata

A szolgáltatás programozott módon történő teljes felügyeletéhez két API-val dolgozik: az Azure AI felügyeleti REST API-jával Keresés, valamint a közös Azure Resource Manager REST API-val.

A Resource Manager API olyan általános célú műveletekhez használatos, amelyek nem szolgáltatásspecifikusak, például előfizetési adatok lekérdezése, földrajzi helyek listázása stb. Minden Resource Manager API-hívás hitelesítése Microsoft Entra ID használatával történik. A Resource Manager API-hívásokhoz 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 már verziószámozottak. Amikor megnyit egy API-referencialapot, válassza ki az API-verziót a legördülő szűrőből.

Képernyőkép a verzióválasztóról.

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

Az adminisztrációs jogosultságokat beépített szerepkörök közvetítik a Microsoft Entra ID:

  • A legtöbb tevékenységhez tulajdonosi vagy közreműködői hozzárendelésekre van szükség.
  • Az olvasói szerepkör korlátozott hozzáféréssel rendelkezik a szolgáltatásadatokhoz (GET-műveletek, kivéve az API-kulcsokat, amelyek tulajdonosi vagy közreműködői engedélyeket igényelnek).

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

Az ajánlott eljárás a szerepkörök csoportokhoz rendelése az egyes felhasználók helyett. Az Azure-előfizetés tulajdonosa vagy globális rendszergazdája kezeli ezeket a hozzárendeléseket. 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égponttalhttps://management.azure.com, majd adja hozzá az előfizetés-azonosítót, a szolgáltatót (Microsoft.Search) és az API-verziót. A műveletek a kérelem törzsében vannak megadva.

A teljes végpont a következő összetevőkkel rendelkezik:

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ához gyakran a következő ügyfeleket használják:

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

A keresési szolgáltatást a Azure Portal is kezelheti.

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

A REST API-k az Azure AI-Keresés alapszintűek, és a programozási modell módosításai először megjelennek a REST API-kban.

Alternatív megoldásként a következő Azure SDK-k érhetők el, amelyek egymástól függetlenül, külön kiadási ütemezés szerint frissülnek:

Lásd még