Admin Keys - Regenerate

Služba:: Search Management

Verze rozhraní API:: 2026-11-01

Znovu vygeneruje primární nebo sekundární klíč rozhraní API pro správu. V jednu chvíli můžete znovu vygenerovat pouze jeden klíč.

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
keyKind	path	True	AdminKeyKind	Určuje, který klíč se má znovu vygenerovat. Mezi platné hodnoty patří "primární" a "sekundární".
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny zdrojů. Název nerozlišuje velikost písmen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Název služby Azure AI Vyhledávač přidružené k zadané skupině prostředků.
subscriptionId	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

Název	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

Název	Typ	Description
200 OK	AdminKeyResult	Operace Azure byla úspěšně dokončena.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 služby Azure Active Directory.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název	Description
user_impersonation	vydávat se za svůj uživatelský účet

Příklady

SearchRegenerateAdminKey

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2026-11-01

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
 *
 * @summary regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
 * x-ms-original-file: 2026-11-01/SearchRegenerateAdminKey.json
 */
async function searchRegenerateAdminKey() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.adminKeys.regenerate("rg1", "mysearchservice", "primary");
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

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

Definice

Název	Description
AdminKeyKind
AdminKeyResult	Odpověď obsahující primární a sekundární administrátorské API klíče pro danou službu Azure AI Vyhledávač.
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

AdminKeyKind

Výčet

Hodnota	Description
primary	Primární klíč rozhraní API pro vyhledávací službu.
secondary	Sekundární klíč rozhraní API pro vyhledávací službu.

AdminKeyResult

Objekt

Odpověď obsahující primární a sekundární administrátorské API klíče pro danou službu Azure AI Vyhledávač.

Název	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.

Název	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.

Název	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 chybné vlastnosti).