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 Cognitive Search-Dienst ab.

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Generiert entweder den primären oder sekundären Administrator-API-Schlüssel neu. Mit einer Operation kann jeweils nur ein Schlüssel neu generiert werden.

Details zur Methode

get(string, string, AdminKeysGetOptionalParams)

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

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

searchServiceName

string

Der Name des Azure Cognitive 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 neu. Mit einer Operation kann jeweils nur ein Schlüssel neu generiert werden.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.

searchServiceName

string

Der Name des Azure Cognitive 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>