Share via

EncryptionProtectorsOperations Class

  • Reference

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

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.

Variables

Name Description
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: str | '_models.EncryptionProtectorName', parameters: '_models.EncryptionProtector', **kwargs: Any) -> LROPoller['_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.
server_name
Required
str

The name of the server.
encryption_protector_name
Required
str or EncryptionProtectorName

The name of the encryption protector to be updated.
parameters
Required
EncryptionProtector

The requested encryption protector resource state.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[EncryptionProtector]

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

Exceptions

Type Description
HttpResponseError

begin_revalidate

Revalidates an existing encryption protector.

begin_revalidate(resource_group_name: str, server_name: str, encryption_protector_name: str | '_models.EncryptionProtectorName', **kwargs: Any) -> LROPoller[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.
server_name
Required
str

The name of the server.
encryption_protector_name
Required
str or EncryptionProtectorName

The name of the encryption protector to be updated.

Keyword-Only Parameters

Name Description
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

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets a server encryption protector.

get(resource_group_name: str, server_name: str, encryption_protector_name: str | '_models.EncryptionProtectorName', **kwargs: Any) -> _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.
server_name
Required
str

The name of the server.
encryption_protector_name
Required
str or EncryptionProtectorName

The name of the encryption protector to be retrieved.

Keyword-Only Parameters

Name Description
cls
callable

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

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) -> Iterable['_models.EncryptionProtectorListResult']

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.
server_name
Required
str

The name of the server.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[EncryptionProtectorListResult]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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