Compartilhar via

QueryKeysOperations Classe

  • Referência

Aviso

NÃO instancie essa classe diretamente.

Em vez disso, você deve acessar as operações a seguir por meio de

SearchManagementClient's

Atributo <xref:query_keys>.

Herança
builtins.object
QueryKeysOperations

Construtor

QueryKeysOperations(*args, **kwargs)

Métodos

create

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

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_by_search_service

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

create

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

create(resource_group_name: str, search_service_name: str, name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> QueryKey

Parâmetros

resource_group_name
str
Obrigatório

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. Obrigatórios.

search_service_name
str
Obrigatório

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

name
str
Obrigatório

O nome da nova chave de API de consulta. Obrigatórios.

search_management_request_options
SearchManagementRequestOptions
Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls
callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

QueryKey ou o resultado de cls(response)

Tipo de retorno

QueryKey

Exceções

HttpResponseError
Confira também

delete

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.

delete(resource_group_name: str, search_service_name: str, key: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> None

Parâmetros

resource_group_name
str
Obrigatório

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. Obrigatórios.

search_service_name
str
Obrigatório

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

key
str
Obrigatório

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

search_management_request_options
SearchManagementRequestOptions
Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls
callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Nenhum ou o resultado de cls(response)

Tipo de retorno

None

Exceções

HttpResponseError
Confira também

list_by_search_service

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

list_by_search_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) -> Iterable[QueryKey]

Parâmetros

resource_group_name
str
Obrigatório

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. Obrigatórios.

search_service_name
str
Obrigatório

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

search_management_request_options
SearchManagementRequestOptions
Obrigatório

Grupo de parâmetros. O valor padrão é Nenhum.

cls
callable

Um tipo ou função personalizado que será passado para a resposta direta

Retornos

Um iterador como a instância de QueryKey ou o resultado de cls(response)

Tipo de retorno

ItemPaged[QueryKey]

Exceções

HttpResponseError
Confira também

Atributos

models 

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>