QueryKeys interface

Pacote:

@azure/arm-search

Interface que representa um QueryKeys.

Métodos

create(string, string, string, QueryKeysCreateOptionalParams)	Gera uma nova chave de consulta para o serviço de pesquisa especificado. Você pode criar até 50 chaves de consulta por serviço.
delete(string, string, string, QueryKeysDeleteOptionalParams)	Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta é excluí-la e recriá-la.
listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)	Retorna a lista de chaves de API de consulta para o serviço Azure Cognitive Search especificado.

Detalhes do método

create(string, string, string, QueryKeysCreateOptionalParams)

Gera uma nova chave de consulta para o serviço de pesquisa especificado. Você pode criar até 50 chaves de consulta por serviço.

function create(resourceGroupName: string, searchServiceName: string, name: string, options?: QueryKeysCreateOptionalParams): Promise<QueryKey>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

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

name

string

O nome da nova chave da API de consulta.

options

QueryKeysCreateOptionalParams

Os parâmetros de opções.

Retornos

Promise<QueryKey>

delete(string, string, string, QueryKeysDeleteOptionalParams)

Exclui a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta é excluí-la e recriá-la.

function delete(resourceGroupName: string, searchServiceName: string, key: string, options?: QueryKeysDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

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

key

string

A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não pelo nome.

options

QueryKeysDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

listBySearchService(string, string, QueryKeysListBySearchServiceOptionalParams)

Retorna a lista de chaves de API de consulta para o serviço Azure Cognitive Search especificado.

function listBySearchService(resourceGroupName: string, searchServiceName: string, options?: QueryKeysListBySearchServiceOptionalParams): PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.

searchServiceName

string

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

options

QueryKeysListBySearchServiceOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<QueryKey, QueryKey[], PageSettings>