Condividi tramite


Query Keys - List By Search Service

Restituisce l'elenco di chiavi API di query per il servizio di ricerca specificato.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys?api-version=2023-11-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse all'interno della sottoscrizione corrente. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.

searchServiceName
path True

string

Nome del servizio di ricerca associato al gruppo di risorse specificato.

subscriptionId
path True

string

Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API Resource Manager di Azure, dagli strumenti da riga di comando o dal portale.

api-version
query True

string

Versione dell'API da usare per ogni richiesta.

Intestazione della richiesta

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

string

uuid

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

Risposte

Nome Tipo Descrizione
200 OK

ListQueryKeysResult

Tutte le chiavi di query per il servizio di ricerca specificato sono state recuperate correttamente e sono nella risposta. È possibile usare una delle chiavi di query come valore del parametro 'api-key' nell'API REST del piano dati o in Azure SDK per eseguire operazioni di sola lettura sulla raccolta di documenti degli indici di ricerca, ad esempio l'esecuzione di query e la ricerca di documenti in base all'ID.

Other Status Codes

CloudError

HTTP 404 (Non trovato): impossibile trovare la sottoscrizione, il gruppo di risorse o il servizio di ricerca. HTTP 409 (Conflitto): la sottoscrizione specificata è disabilitata.

Sicurezza

azure_auth

Microsoft Entra ID flusso di autorizzazione OAuth2.

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

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

SearchListQueryKeysBySearchService

Esempio di richiesta

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listQueryKeys?api-version=2023-11-01

Risposta di esempio

{
  "value": [
    {
      "name": "Query key for browser-based clients",
      "key": "<a query API key>"
    },
    {
      "name": "Query key for mobile clients",
      "key": "<another 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.

ListQueryKeysResult

Risposta contenente le chiavi API di query per un determinato servizio di ricerca.

QueryKey

Descrive una chiave API per un determinato servizio di ricerca con autorizzazioni solo per le operazioni di query.

CloudError

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.

CloudErrorBody

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.

ListQueryKeysResult

Risposta contenente le chiavi API di query per un determinato servizio di ricerca.

Nome Tipo Descrizione
nextLink

string

URL della richiesta che può essere usato per eseguire query sulla pagina successiva delle chiavi di query. Restituito quando il numero totale di chiavi di query richieste supera le dimensioni massime della pagina.

value

QueryKey[]

Chiavi di query per il servizio di ricerca.

QueryKey

Descrive una chiave API per un determinato servizio di ricerca con autorizzazioni solo per le operazioni di query.

Nome Tipo Descrizione
key

string

Valore della chiave API di query.

name

string

Nome della chiave API di query; può essere vuoto.