Freigeben über


AdminKeys interface

Schnittstelle, die einen AdminKeys darstellt.

Methoden

get(string, string, AdminKeysGetOptionalParams)

Ruft die primären und sekundären Administrator-API-Schlüssel für den angegebenen Azure AI Search-Dienst ab.

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Generiert entweder den primären oder sekundären Administrator-API-Schlüssel. Sie können jeweils nur einen Schlüssel neu generieren.

Details zur Methode

get(string, string, AdminKeysGetOptionalParams)

Ruft die primären und sekundären Administrator-API-Schlüssel für den angegebenen Azure AI Search-Dienst ab.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.

searchServiceName

string

Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

options
AdminKeysGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AdminKeyResult>

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Generiert entweder den primären oder sekundären Administrator-API-Schlüssel. Sie können jeweils nur einen Schlüssel neu generieren.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.

searchServiceName

string

Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.

keyKind
AdminKeyKind

Gibt an, welcher Schlüssel neu generiert werden soll. Gültige Werte sind "primär" und "sekundär".

options
AdminKeysRegenerateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<AdminKeyResult>