Megosztás a következőn keresztül:


Admin Keys - Get

Lekéri a megadott keresési szolgáltatás elsődleges és másodlagos rendszergazdai API-kulcsait.

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

URI-paraméterek

Name In Kötelező Típus Description
resourceGroupName
path True

string

Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.

searchServiceName
path True

string

A megadott erőforráscsoporthoz társított keresési szolgáltatás neve.

subscriptionId
path True

string

A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, parancssori eszközökből vagy a portálról szerezheti be.

api-version
query True

string

Az egyes kérésekhez használni kívánt API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-client-request-id

string

uuid

Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Válaszok

Name Típus Description
200 OK

AdminKeyResult

A rendszergazdai kulcsok lekérése sikerült, és a válaszban szerepelnek. Az elsődleges vagy a másodlagos kulcsot használhatja az "api-key" paraméter értékeként a REST API adatsíkban vagy egy Azure SDK-ban a keresési szolgáltatáson végzett bármely művelet végrehajtásához, beleértve a kiemelt műveleteket is. A kiemelt műveletek közé tartoznak az erőforrások, például az indexek és adatforrások kezelése, valamint az indexekben lévő adatok feltöltése, módosítása vagy törlése.

Other Status Codes

CloudError

HTTP 404 (Nem található): Az előfizetés, az erőforráscsoport vagy a keresési szolgáltatás nem található. HTTP 409 (ütközés): A megadott előfizetés le van tiltva.

Biztonság

azure_auth

Microsoft Entra ID OAuth2 engedélyezési folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

SearchGetAdminKeys

Mintakérelem

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

Mintaválasz

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definíciók

Name Description
AdminKeyResult

Adott keresési szolgáltatás elsődleges és másodlagos rendszergazdai API-kulcsait tartalmazó válasz.

CloudError

API-hibával kapcsolatos információkat tartalmaz.

CloudErrorBody

Egy adott API-hibát ír le hibakóddal és üzenettel.

AdminKeyResult

Adott keresési szolgáltatás elsődleges és másodlagos rendszergazdai API-kulcsait tartalmazó válasz.

Name Típus Description
primaryKey

string

A keresési szolgáltatás elsődleges rendszergazdai API-kulcsa.

secondaryKey

string

A keresési szolgáltatás másodlagos rendszergazdai API-kulcsa.

CloudError

API-hibával kapcsolatos információkat tartalmaz.

Name Típus Description
error

CloudErrorBody

Egy adott API-hibát ír le hibakóddal és üzenettel.

CloudErrorBody

Egy adott API-hibát ír le hibakóddal és üzenettel.

Name Típus Description
code

string

Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaesetek programozott kezelésére használható.

details

CloudErrorBody[]

Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.

message

string

Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat nyújt.

target

string

Az adott hiba célja (például a hiba tulajdonságának neve).