EndpointKeysOperations Class

EndpointKeysOperations operations.

Inheritance

builtins.object

EndpointKeysOperations

Constructor

EndpointKeysOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Methods

get_keys	Gets endpoint keys for an endpoint.
refresh_keys	Re-generates an endpoint key.

get_keys

Gets endpoint keys for an endpoint.

get_keys(custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
EndpointKeysDTO, <xref:msrest.pipeline.ClientRawResponse>	EndpointKeysDTO or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

refresh_keys

Re-generates an endpoint key.

refresh_keys(key_type, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
key_type Required	str Type of Key
custom_headers	dict headers that will be added to the request Default value: None
raw	bool returns the direct response alongside the deserialized response Default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
EndpointKeysDTO, <xref:msrest.pipeline.ClientRawResponse>	EndpointKeysDTO or ClientRawResponse if raw=true

Exceptions

Type	Description
ErrorResponseException

Attributes

models

models = <module 'azure.cognitiveservices.knowledge.qnamaker.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\knowledge\\qnamaker\\models\\__init__.py'>