AdminKeys interface

Pakiet:

@azure/arm-search

Interfejs reprezentujący klucz administracyjny.

Metody

get(string, string, AdminKeysGetOptionalParams)	Pobiera podstawowe i pomocnicze klucze interfejsu API administratora dla określonej usługi Azure AI Search.
regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)	Ponownie generuje podstawowy lub pomocniczy klucz interfejsu API administratora. Jednocześnie można wygenerować tylko jeden klucz.

Szczegóły metody

get(string, string, AdminKeysGetOptionalParams)

Pobiera podstawowe i pomocnicze klucze interfejsu API administratora dla określonej usługi Azure AI Search.

function get(resourceGroupName: string, searchServiceName: string, options?: AdminKeysGetOptionalParams): Promise<AdminKeyResult>

Parametry

resourceGroupName

string

Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.

searchServiceName

string

Nazwa usługi Azure AI Search skojarzonej z określoną grupą zasobów.

options

AdminKeysGetOptionalParams

Parametry opcji.

Zwraca

Promise<AdminKeyResult>

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Ponownie generuje podstawowy lub pomocniczy klucz interfejsu API administratora. Jednocześnie można wygenerować tylko jeden klucz.

function regenerate(resourceGroupName: string, searchServiceName: string, keyKind: AdminKeyKind, options?: AdminKeysRegenerateOptionalParams): Promise<AdminKeyResult>

Parametry

resourceGroupName

string

Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.

searchServiceName

string

Nazwa usługi Azure AI Search skojarzonej z określoną grupą zasobów.

keyKind

AdminKeyKind

Określa klucz do ponownego wygenerowania. Prawidłowe wartości to "primary" i "secondary".

options

AdminKeysRegenerateOptionalParams

Parametry opcji.

Zwraca

Promise<AdminKeyResult>