EncryptionProtectorsOperations Class

EncryptionProtectorsOperations 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

EncryptionProtectorsOperations

Constructor

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

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.

begin_create_or_update(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], parameters: _models.EncryptionProtector, **kwargs: Any) -> LROPoller[_models.EncryptionProtector]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

encryption_protector_name

str or EncryptionProtectorName

Required

The name of the encryption protector to be updated.

parameters

EncryptionProtector

Required

The requested encryption protector resource state.

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EncryptionProtector or the result of cls(response)

Return type

LROPoller[EncryptionProtector]

Exceptions

HttpResponseError

begin_revalidate

Revalidates an existing encryption protector.

begin_revalidate(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

encryption_protector_name

str or EncryptionProtectorName

Required

The name of the encryption protector to be updated.

cls

callable

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

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

get

Gets a server encryption protector.

get(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], **kwargs: Any) -> _models.EncryptionProtector

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

encryption_protector_name

str or EncryptionProtectorName

Required

The name of the encryption protector to be retrieved.

cls

callable

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

Returns

EncryptionProtector, or the result of cls(response)

Return type

EncryptionProtector

Exceptions

HttpResponseError

list_by_server

Gets a list of server encryption protectors.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable[_models.EncryptionProtectorListResult]

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

cls

callable

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

Returns

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

Return type

ItemPaged[EncryptionProtectorListResult]

Exceptions

HttpResponseError

Attributes

models

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