Admin Keys - Get

Služba:
Search Management
Verze rozhraní API:
2025-02-01-preview

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-02-01-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
 path True

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName
 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ů.
subscriptionId
 path True

string

Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
api-version
 query True

string

Verze rozhraní API, která se má použít pro každý požadavek.

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

AdminKeyResult

Klíče správce byly úspěšně načteny a jsou v odpovědi. Primární nebo sekundární klíč můžete použít jako hodnotu parametru api-key v rozhraní REST API služby Azure AI Search nebo sadě SDK k provádění jakýchkoli operací ve vyhledávací službě, včetně privilegovaných operací. Mezi privilegované operace patří správa prostředků, jako jsou indexy a zdroje dat, a také nahrávání, úpravy nebo odstraňování dat v indexech.
Other Status Codes

CloudError

HTTP 404 (Nenalezena): Nepodařilo se najít předplatné, skupinu prostředků nebo vyhledávací službu. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

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

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2025-02-01-preview

Ukázková odpověď

Stavový kód:
200 
{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definice

Name Description
AdminKeyResult

Odpověď obsahující primární a sekundární klíče rozhraní API pro správu pro danou službu Azure AI Search
CloudError

Obsahuje informace o chybě rozhraní API.
CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

AdminKeyResult

Objekt

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

Objekt

Obsahuje informace o chybě rozhraní API.

Name Typ Description
error

CloudErrorBody

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

Objekt

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

CloudErrorBody[]

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ě).