Informazioni di riferimento sull'API REST di gestione (Search di Intelligenza artificiale di Azure)

  • Articolo

Le API REST di gestione delle Search di intelligenza artificiale di Azure (in precedenza note 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 sul servizio di ricerca
  • Creare, rigenerare o recuperare api-keys (query o chiavi di 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 Search.

Come usare le API REST di gestione

Per amministrare completamente il servizio a livello di codice, usare due API: l'API REST di gestione di Azure ai Search documentata qui, oltre all'API REST comune di Azure Resource Manager.

L'API Resource Manager viene usata per operazioni per utilizzo generico che non sono specifiche del servizio, ad esempio l'esecuzione di query sui dati della sottoscrizione, l'elenco di posizioni geografiche e così via. Tutte le chiamate API Resource Manager vengono autenticate usando Microsoft Entra ID. È necessario avere un'appartenenza e un'assegnazione di ruolo in un tenant Microsoft Entra per effettuare chiamate API Resource Manager.

Documentazione dell'API con versione

I documenti dell'API REST sono ora versioneti. 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 in Microsoft Entra ID:

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

Per altre informazioni, vedere Controllo degli accessi in base al ruolo in Azure ai Search.

Una procedura consigliata consiste nell'assegnare ruoli ai gruppi anziché ai singoli utenti. Un proprietario della sottoscrizione di Azure o un amministratore globale gestisce queste assegnazioni. Per altre informazioni, vedere Assegnare ruoli Microsoft Entra ai gruppi.

Connettersi all'endpoint di gestione

Quando si configura la connessione, iniziare con l'endpoint https://management.azure.com Resource Manager e quindi aggiungere l'ID sottoscrizione, il provider (Microsoft.Search) e la versione dell'API. Le operazioni vengono 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 usati per chiamare le API REST di gestione:

Client Istruzioni ed esempi
Azure PowerShell usando il modulo Az.Search Gestire Search di Intelligenza artificiale di Azure usando Azure PowerShell
Interfaccia della riga di comando di Azure Gestire Search di intelligenza artificiale di Azure usando l'interfaccia della riga di comando di Azure
Visual Studio Code con il client REST Gestire Search di Intelligenza artificiale di Azure usando 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 i Search 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 versione separate:

Vedi anche