Share via

ManagedInstanceEncryptionProtectorsOperations Class

  • Reference

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

Constructor

ManagedInstanceEncryptionProtectorsOperations(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 managed instance encryption protector.
list_by_instance

Gets a list of managed instance encryption protectors.

begin_create_or_update

Updates an existing encryption protector.

async begin_create_or_update(resource_group_name: str, managed_instance_name: str, encryption_protector_name: str | EncryptionProtectorName, parameters: ManagedInstanceEncryptionProtector, **kwargs: Any) -> AsyncLROPoller[ManagedInstanceEncryptionProtector]

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

The name of the managed instance.
encryption_protector_name
Required
str or EncryptionProtectorName

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

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[ManagedInstanceEncryptionProtector]

An instance of AsyncLROPoller that returns either ManagedInstanceEncryptionProtector or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_revalidate

Revalidates an existing encryption protector.

async begin_revalidate(resource_group_name: str, managed_instance_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.
managed_instance_name
Required
str

The name of the managed instance.
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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

Gets a managed instance encryption protector.

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

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

The name of the managed instance.
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
ManagedInstanceEncryptionProtector

ManagedInstanceEncryptionProtector, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_instance

Gets a list of managed instance encryption protectors.

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) -> AsyncIterable[ManagedInstanceEncryptionProtectorListResult]

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

The name of the managed instance.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[ManagedInstanceEncryptionProtectorListResult]

An iterator like instance of either ManagedInstanceEncryptionProtectorListResult 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'>