Share via

ManagedInstanceLongTermRetentionPoliciesOperations Class

  • Reference

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

Constructor

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

Sets a managed database's long term retention policy.
get

Gets a managed database's long term retention policy.
list_by_database

Gets a database's long term retention policy.

begin_create_or_update

Sets a managed database's long term retention policy.

async begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: str | ManagedInstanceLongTermRetentionPolicyName, parameters: ManagedInstanceLongTermRetentionPolicy, **kwargs: Any) -> AsyncLROPoller[ManagedInstanceLongTermRetentionPolicy]

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

The name of the database.
policy_name
Required
str or ManagedInstanceLongTermRetentionPolicyName

The policy name. Should always be Default.
parameters
Required
ManagedInstanceLongTermRetentionPolicy

The long term retention policy info.

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[ManagedInstanceLongTermRetentionPolicy]

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

Exceptions

Type Description
HttpResponseError

get

Gets a managed database's long term retention policy.

async get(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: str | ManagedInstanceLongTermRetentionPolicyName, **kwargs: Any) -> ManagedInstanceLongTermRetentionPolicy

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

The name of the database.
policy_name
Required
str or ManagedInstanceLongTermRetentionPolicyName

The policy name. Should always be Default.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ManagedInstanceLongTermRetentionPolicy

ManagedInstanceLongTermRetentionPolicy, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_database

Gets a database's long term retention policy.

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) -> AsyncIterable[ManagedInstanceLongTermRetentionPolicyListResult]

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

The name of the database.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[ManagedInstanceLongTermRetentionPolicyListResult]

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