Condividi tramite

Informazioni di riferimento sull'API REST di gestione (Ricerca di Azure per intelligenza artificiale)

Le API REST di gestione di Ricerca per intelligenza artificiale di Azure (precedentemente nota come Ricerca cognitiva di Azure) forniscono l'accesso a livello di codice alle operazioni amministrative:

  • Creare, aggiornare ed eliminare un servizio di ricerca
  • Recuperare le informazioni del servizio di ricerca
  • Creare, rigenerare o recuperare api-keys (query o chiavi amministratore)
  • Aggiungere o rimuovere repliche e partizioni (regolare la capacità)
  • Configurare un servizio di ricerca per l'uso di un endpoint privato
  • Abilitare o disabilitare il controllo degli accessi in base al ruolo di Azure

Per le attività del piano dati, ad esempio la creazione e l'esecuzione di query su un indice, usare invece le API REST del servizio di ricerca .

Come usare le API REST di gestione

Per amministrare completamente il servizio a livello di codice, si usano due API: l'API REST di gestione di Ricerca per intelligenza artificiale di Azure documentata qui, oltre all'API REST comune di Azure Resource Manager.

L'API di Resource Manager viene usata per operazioni generiche che non sono specifiche del servizio, ad esempio l'esecuzione di query sui dati delle sottoscrizioni, l'elenco delle posizioni geografiche e così via. Tutte le chiamate API di Resource Manager vengono autenticate usando l'ID Microsoft Entra. Per effettuare chiamate all'API di Resource Manager, è necessario disporre dell'appartenenza e di un'assegnazione di ruolo in un tenant di Microsoft Entra.

Documentazione dell'API con controllo delle versioni

I documenti dell'API REST sono sottoposti a controllo delle versioni. Quando si apre una pagina di riferimento api, selezionare la versione dell'API dal filtro a discesa.

Screenshot del selettore di versione.

Autorizzazioni e controllo di accesso

I diritti di amministrazione vengono trasmessi tramite ruoli predefiniti nell'ID Microsoft Entra:

  • Le assegnazioni di proprietario o collaboratore sono necessarie per la maggior parte delle attività.
  • Il ruolo Lettore ha accesso limitato alle informazioni del servizio (operazioni GET, ad eccezione delle chiavi API, che richiedono autorizzazioni di Proprietario o Collaboratore).

Per altre informazioni, vedere Controllo degli accessi in base al ruolo in Ricerca di intelligenza artificiale di Azure.

Una procedura consigliata consiste nell'assegnare ruoli ai gruppi anziché ai singoli utenti. Queste assegnazioni sono gestite da un proprietario o da un amministratore globale della sottoscrizione di Azure. Per ulteriori informazioni, consultare Assegna ruoli di Microsoft Entra ai gruppi.

Connettersi all'endpoint di gestione

Quando si configura la connessione, iniziare con l'endpoint https://management.azure.com di Resource Manager e quindi aggiungere l'ID sottoscrizione, il provider (Microsoft.Search) e la versione dell'API. Le operazioni sono specificate nel corpo della richiesta.

Un endpoint completamente specificato include i componenti seguenti:

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

I client seguenti vengono comunemente utilizzati per chiamare le API REST di gestione:

Cliente Istruzioni ed esempi
Azure PowerShell con il modulo Az.Search Gestire la ricerca di intelligenza artificiale di Azure con Azure PowerShell
Interfaccia Command-Line di Azure (CLI) Gestire Ricerca intelligenza artificiale di Azure usando l'interfaccia della riga di comando di Azure
Visual Studio Code con il client REST Gestire la ricerca di intelligenza artificiale di Azure con REST

È anche possibile gestire un servizio di ricerca usando il portale di Azure.

API di gestione in altri SDK

Le API REST sono fondamentali per Ricerca di intelligenza artificiale di Azure e tutte le modifiche apportate al modello di programmazione vengono riflesse prima nelle API REST.

Le alternative includono gli SDK di Azure seguenti, che vengono aggiornati in modo indipendente in pianificazioni di rilascio separate:

Vedere anche

  • Last updated on