ManagedInstanceLongTermRetentionPoliciesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:managed_instance_long_term_retention_policies> attribute.

Constructor

ManagedInstanceLongTermRetentionPoliciesOperations(*args, **kwargs)

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 | _models.ManagedInstanceLongTermRetentionPolicyName, parameters: _models.ManagedInstanceLongTermRetentionPolicy, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.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. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the database. Required.
policy_name Required	str or ManagedInstanceLongTermRetentionPolicyName The policy name. Should always be Default. "default" Required.
parameters Required	ManagedInstanceLongTermRetentionPolicy or IO[bytes] The long term retention policy info. Is either a ManagedInstanceLongTermRetentionPolicy type or a IO[bytes] type. Required.

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. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the database. Required.
policy_name Required	str or ManagedInstanceLongTermRetentionPolicyName The policy name. Should always be Default. "default" Required.

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) -> AsyncItemPaged[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. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the database. Required.

Returns

Type	Description
AsyncItemPaged[ManagedInstanceLongTermRetentionPolicy]	An iterator like instance of either ManagedInstanceLongTermRetentionPolicy 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'>