Condividi tramite

Admin Keys - Get

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

Ottiene le chiavi API di amministrazione primaria e secondaria per il servizio Di ricerca di intelligenza artificiale di Azure specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
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

AdminKeyResult

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

SearchGetAdminKeys

Esempio di richiesta

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-05-01

Risposta di esempio

Codice di stato:
200 
{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definizioni

Nome Descrizione
AdminKeyResult

Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio ricerca di intelligenza artificiale di Azure.
CloudError

Contiene informazioni su un errore dell'API.
CloudErrorBody

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

AdminKeyResult

Oggetto

Risposta contenente le chiavi API di amministrazione primaria e secondaria per un determinato servizio ricerca di intelligenza artificiale di Azure.

Nome Tipo Descrizione
primaryKey

string

Chiave API di amministrazione primaria del servizio di ricerca.
secondaryKey

string

Chiave API di amministrazione secondaria del servizio di ricerca.

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.