Compartilhar via


AdminKeys interface

Interface que representa um AdminKeys.

Métodos

get(string, string, AdminKeysGetOptionalParams)

Obtém as chaves de API de administração primárias e secundárias para o serviço de Azure Cognitive Search especificado.

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Regenera a chave de API de administração primária ou secundária. Você só pode regenerar uma chave de cada vez.

Detalhes do método

get(string, string, AdminKeysGetOptionalParams)

Obtém as chaves de API de administração primárias e secundárias para o serviço de Azure Cognitive Search especificado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName

string

O nome do serviço Azure Cognitive Search associado ao grupo de recursos especificado.

options
AdminKeysGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<AdminKeyResult>

regenerate(string, string, AdminKeyKind, AdminKeysRegenerateOptionalParams)

Regenera a chave de API de administração primária ou secundária. Você só pode regenerar uma chave de cada vez.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

searchServiceName

string

O nome do serviço Azure Cognitive Search associado ao grupo de recursos especificado.

keyKind
AdminKeyKind

Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'.

options
AdminKeysRegenerateOptionalParams

Os parâmetros de opções.

Retornos

Promise<AdminKeyResult>