QueryKeys interface
Interface que representa um QueryKeys.
Métodos
create(string, string, string, Query |
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, Query |
Exclui a chave de consulta especificada. Ao contrário das chaves de administração, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em excluí-la e recriá-la. |
list |
Retorna a lista de chaves de API de consulta para o serviço de Azure Cognitive Search determinado. |
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 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.
- name
-
string
O nome da nova chave de 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 administração, as chaves de consulta não são regeneradas. O processo para regenerar uma chave de consulta consiste em 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 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.
- key
-
string
A chave de consulta a ser excluída. As chaves de consulta são identificadas por valor, não por 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 de Azure Cognitive Search determinado.
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 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.
Os parâmetros de opções.