Condividi tramite

Query Keys - Create

Servizio:
Search Management
Versione API:
2025-05-01

Genera una nuova chiave di query per il servizio di ricerca specificato. È possibile creare fino a 50 chiavi di query per servizio.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}?api-version=2025-05-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
name
 path True

string

Nome della nuova chiave API di query.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

Nome del servizio Ricerca intelligenza artificiale di Azure associato al gruppo di risorse specificato.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string (uuid)

Valore GUID generato dal client che identifica questa richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.

Risposte

Nome Tipo Descrizione
200 OK

QueryKey

L'operazione di Azure è stata completata correttamente.
Other Status Codes

CloudError

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

SearchCreateQueryKey

Esempio di richiesta

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/createQueryKey/An API key granting read-only access to the documents collection of an index.?api-version=2025-05-01

Risposta di esempio

Codice di stato:
200 
{
  "name": "An API key granting read-only access to the documents collection of an index.",
  "key": "<a query API key>"
}

Definizioni

Nome Descrizione
CloudError

Contiene informazioni su un errore dell'API.
CloudErrorBody

Descrive un particolare errore dell'API con un codice di errore e un messaggio.
QueryKey

Descrive una chiave API per un determinato servizio ricerca di intelligenza artificiale di Azure che fornisce autorizzazioni di sola lettura per la raccolta di documenti di un indice.

CloudError

Oggetto

Contiene informazioni su un errore dell'API.

Nome Tipo Descrizione
error

CloudErrorBody

Descrive un particolare errore dell'API con un codice di errore e un messaggio.
message

string

Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/debug fare riferimento alla proprietà 'error.message').

CloudErrorBody

Oggetto

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome Tipo Descrizione
code

string

Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details

CloudErrorBody[]

Contiene errori annidati correlati a questo errore.
message

string

Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target

string

Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

QueryKey

Oggetto

Descrive una chiave API per un determinato servizio ricerca di intelligenza artificiale di Azure che fornisce autorizzazioni di sola lettura per la raccolta di documenti di un indice.

Nome Tipo Descrizione
key

string

Valore della chiave API di query.
name

string

Nome della chiave API di query. I nomi delle query sono facoltativi, ma l'assegnazione di un nome consente di ricordare come viene usata.