Admin Keys - Get
Získá primární a sekundární klíče rozhraní API pro správu pro zadanou službu Azure AI Search.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2025-05-01
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Název skupiny prostředků. Název nerozlišuje malá a velká písmena. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
Název služby Azure AI Search přidružené k zadané skupině prostředků. |
|
subscription
|
path | True |
string (uuid) |
ID cílového předplatného. Hodnota musí být UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
| Name | Vyžadováno | Typ | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
Operace Azure byla úspěšně dokončena. |
|
| Other Status Codes |
Neočekávaná chybová odpověď |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
| Name | Description |
|---|---|
| user_impersonation | zosobnění uživatelského účtu |
Příklady
SearchGetAdminKeys
Ukázkový požadavek
Ukázková odpověď
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definice
| Name | Description |
|---|---|
|
Admin |
Odpověď obsahující primární a sekundární klíče rozhraní API pro správu pro danou službu Azure AI Search |
|
Cloud |
Obsahuje informace o chybě rozhraní API. |
|
Cloud |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
AdminKeyResult
Odpověď obsahující primární a sekundární klíče rozhraní API pro správu pro danou službu Azure AI Search
| Name | Typ | Description |
|---|---|---|
| primaryKey |
string |
Primární klíč rozhraní API správce vyhledávací služby. |
| secondaryKey |
string |
Sekundární klíč rozhraní API pro správu vyhledávací služby. |
CloudError
Obsahuje informace o chybě rozhraní API.
| Name | Typ | Description |
|---|---|---|
| error |
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou. |
|
| message |
string |
Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message). |
CloudErrorBody
Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
| Name | Typ | Description |
|---|---|---|
| code |
string |
Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb. |
| details |
Obsahuje vnořené chyby, které souvisejí s touto chybou. |
|
| message |
string |
Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění. |
| target |
string |
Cíl konkrétní chyby (například název vlastnosti v chybě). |