QueryKeysOperations Classe

Aviso

NÃO instancia esta classe diretamente.

Em vez disso, deve aceder às seguintes operações através de

SearchManagementClient's

<xref:query_keys> atributo.

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. Pode criar até 50 chaves de consulta por serviço.
delete	Elimina a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo de regeneração de uma chave de consulta é eliminar e, em seguida, recriá-la.
list_by_search_service	Devolve a lista de chaves de API de consulta para o serviço de Azure Cognitive Search especificado.

create

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

async 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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

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

name

str

Necessário

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

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

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

Devoluções

QueryKey ou o resultado de cls(response)

Tipo de retorno

QueryKey

Exceções

HttpResponseError

Ver também

• https://aka.ms/search-manage

delete

Elimina a chave de consulta especificada. Ao contrário das chaves de administrador, as chaves de consulta não são regeneradas. O processo de regeneração de uma chave de consulta é eliminar e, em seguida, recriá-la.

async 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

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

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

key

str

Necessário

A chave de consulta a eliminar. As chaves de consulta são identificadas por valor e não pelo nome. Obrigatório.

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

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

Devoluções

Nenhum ou o resultado de cls(resposta)

Tipo de retorno

None

Exceções

HttpResponseError

Ver também

• https://aka.ms/search-manage

list_by_search_service

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

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

Parâmetros

resource_group_name

str

Necessário

O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal. Obrigatório.

search_service_name

str

Necessário

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

search_management_request_options

SearchManagementRequestOptions

Necessário

Grupo de parâmetros. O valor predefinido é Nenhum.

cls

callable

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

Devoluções

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

Tipo de retorno

AsyncItemPaged[QueryKey]

Exceções

HttpResponseError

Ver também

• https://aka.ms/search-manage

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'>