Admin Keys - Regenerate
Újragenerálja az elsődleges vagy a másodlagos rendszergazdai API-kulcsot. Egyszerre csak egy kulcsot lehet újragenerálni.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2025-05-01
URI-paraméterek
| Név | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
key
|
path | True |
Megadja, hogy melyik kulcsot kell újragenerálni. Az érvényes értékek közé tartozik az "elsődleges" és a "másodlagos". |
|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket. |
|
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
A megadott erőforráscsoporthoz társított Azure AI Search szolgáltatás neve. |
|
subscription
|
path | True |
string (uuid) |
A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használandó API-verzió. |
Kérelem fejléce
| Név | 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
| Név | Típus | Description |
|---|---|---|
| 200 OK |
Az Azure-művelet sikeresen befejeződött. |
|
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
azure_auth
Azure Active Directory Oauth2-folyamat.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
| Név | Description |
|---|---|
| user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
SearchRegenerateAdminKey
Mintakérelem
Mintaválasz
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definíciók
| Név | Description |
|---|---|
|
Admin |
|
|
Admin |
Egy adott Azure AI Search szolgáltatás elsődleges és másodlagos rendszergazdai API-kulcsait tartalmazó válasz. |
|
Cloud |
Api-hibával kapcsolatos információkat tartalmaz. |
|
Cloud |
Egy adott API-hibát ír le egy hibakóddal és egy üzenettel. |
AdminKeyKind
| Érték | Description |
|---|---|
| primary |
A keresési szolgáltatás elsődleges API-kulcsa. |
| secondary |
A keresési szolgáltatás másodlagos API-kulcsa. |
AdminKeyResult
Egy adott Azure AI Search szolgáltatás elsődleges és másodlagos rendszergazdai API-kulcsait tartalmazó válasz.
| Név | 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.
| Név | Típus | Description |
|---|---|---|
| error |
Egy adott API-hibát ír le egy hibakóddal és egy üzenettel. |
|
| message |
string |
A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot). |
CloudErrorBody
Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
| Név | Típus | Description |
|---|---|---|
| code |
string |
Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet. |
| details |
Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak. |
|
| message |
string |
A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet. |
| target |
string |
Az adott hiba célja (például a hiba tulajdonságának neve). |