Admin Keys - Get
Ottiene le chiavi API di amministrazione primaria e secondaria per il servizio di ricerca specificato.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
resource
|
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. |
search
|
path | True |
string |
Nome del servizio di ricerca associato al gruppo di risorse specificato. |
subscription
|
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 |
Le chiavi di amministrazione sono state recuperate correttamente e sono nella risposta. È possibile usare la chiave primaria o secondaria come valore del parametro 'api-key' nell'API REST del piano dati o azure SDK per eseguire qualsiasi operazione nel servizio di ricerca, incluse le operazioni con privilegi. Le operazioni con privilegi includono la gestione di risorse come indici e origini dati, nonché il caricamento, la modifica o l'eliminazione di dati negli indici. |
|
Other Status Codes |
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
SearchGetAdminKeys
Esempio di richiesta
Risposta di esempio
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definizioni
Nome | Descrizione |
---|---|
Admin |
Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio di ricerca. |
Cloud |
Contiene informazioni su un errore dell'API. |
Cloud |
Descrive un particolare errore dell'API con un codice di errore e un messaggio. |
AdminKeyResult
Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
primaryKey |
string |
Chiave API amministratore primaria del servizio di ricerca. |
secondaryKey |
string |
Chiave API amministratore secondaria del servizio di ricerca. |
CloudError
Contiene informazioni su un errore dell'API.
Nome | Tipo | Descrizione |
---|---|---|
error |
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 |
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. |