QueryKeysOperations Class

QueryKeysOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

QueryKeysOperations

Constructor

QueryKeysOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create	Generates a new query key for the specified search service. You can create up to 50 query keys per service.
delete	Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
list_by_search_service	Returns the list of query API keys for the given Azure Cognitive Search service.

create

Generates a new query key for the specified search service. You can create up to 50 query keys per service.

async create(resource_group_name: str, search_service_name: str, name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.QueryKey

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service associated with the specified resource group.

name

str

Required

The name of the new query API key.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

QueryKey, or the result of cls(response)

Return type

QueryKey

Exceptions

HttpResponseError

delete

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

async delete(resource_group_name: str, search_service_name: str, key: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> None

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service associated with the specified resource group.

key

str

Required

The query key to be deleted. Query keys are identified by value, not by name.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

list_by_search_service

Returns the list of query API keys for the given Azure Cognitive Search service.

list_by_search_service(resource_group_name: str, search_service_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> AsyncIterable[azure.mgmt.search.models._models_py3.ListQueryKeysResult]

Parameters

resource_group_name

str

Required

The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

search_service_name

str

Required

The name of the Azure Cognitive Search service associated with the specified resource group.

search_management_request_options

SearchManagementRequestOptions

default value: None

Parameter group.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ListQueryKeysResult or the result of cls(response)

Return type

AsyncItemPaged[ListQueryKeysResult]

Exceptions

HttpResponseError

Attributes

models

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