EncryptionProtectorsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:encryption_protectors> attribute.

Constructor

EncryptionProtectorsOperations(*args, **kwargs)

Methods

begin_create_or_update	Updates an existing encryption protector.
begin_revalidate	Revalidates an existing encryption protector.
get	Gets a server encryption protector.
list_by_server	Gets a list of server encryption protectors.

begin_create_or_update

Updates an existing encryption protector.

async begin_create_or_update(resource_group_name: str, server_name: str, encryption_protector_name: str | _models.EncryptionProtectorName, parameters: _models.EncryptionProtector, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.EncryptionProtector]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
encryption_protector_name Required	str or EncryptionProtectorName The name of the encryption protector to be updated. "current" Required.
parameters Required	EncryptionProtector or IO[bytes] The requested encryption protector resource state. Is either a EncryptionProtector type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[EncryptionProtector]	An instance of AsyncLROPoller that returns either EncryptionProtector or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_revalidate

Revalidates an existing encryption protector.

async begin_revalidate(resource_group_name: str, server_name: str, encryption_protector_name: str | EncryptionProtectorName, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
encryption_protector_name Required	str or EncryptionProtectorName The name of the encryption protector to be updated. "current" Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a server encryption protector.

async get(resource_group_name: str, server_name: str, encryption_protector_name: str | EncryptionProtectorName, **kwargs: Any) -> EncryptionProtector

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
encryption_protector_name Required	str or EncryptionProtectorName The name of the encryption protector to be retrieved. "current" Required.

Returns

Type	Description
EncryptionProtector	EncryptionProtector or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Gets a list of server encryption protectors.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[EncryptionProtector]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.

Returns

Type	Description
AsyncItemPaged[EncryptionProtector]	An iterator like instance of either EncryptionProtector or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>