AdminKeysOperations Class

AdminKeysOperations 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

AdminKeysOperations

Constructor

AdminKeysOperations(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

get	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
regenerate	Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

get

Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.

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

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

AdminKeyResult, or the result of cls(response)

Return type

AdminKeyResult

Exceptions

HttpResponseError

regenerate

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

async regenerate(resource_group_name: str, search_service_name: str, key_kind: Union[str, azure.mgmt.search.models._search_management_client_enums.AdminKeyKind], search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.AdminKeyResult

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_kind

str or AdminKeyKind

Required

Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.

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

AdminKeyResult, or the result of cls(response)

Return type

AdminKeyResult

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