LongTermRetentionBackupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:long_term_retention_backups> attribute.

Constructor

LongTermRetentionBackupsOperations(*args, **kwargs)

Methods

begin_change_access_tier	Change a long term retention backup access tier.
begin_change_access_tier_by_resource_group	Change a long term retention backup access tier.
begin_copy	Copy an existing long term retention backup.
begin_copy_by_resource_group	Copy an existing long term retention backup to a different server.
begin_delete	Deletes a long term retention backup.
begin_delete_by_resource_group	Deletes a long term retention backup.
begin_lock_time_based_immutability	Lock time based immutability of an existing long term retention backup.
begin_lock_time_based_immutability_by_resource_group	Lock time based immutability of an existing long term retention backup.
begin_remove_legal_hold_immutability	Remove legal hold immutability of an existing long term retention backup.
begin_remove_legal_hold_immutability_by_resource_group	Remove legal hold immutability of an existing long term retention backup.
begin_remove_time_based_immutability	Remove time based immutability of an existing long term retention backup.
begin_remove_time_based_immutability_by_resource_group	Remove time based immutability of an existing long term retention backup.
begin_set_legal_hold_immutability	Set legal hold immutability of an existing long term retention backup.
begin_set_legal_hold_immutability_by_resource_group	Set legal hold immutability of an existing long term retention backup.
begin_update	Updates an existing long term retention backup.
begin_update_by_resource_group	Updates an existing long term retention backup.
get	Gets a long term retention backup.
get_by_resource_group	Gets a long term retention backup.
list_by_database	Lists all long term retention backups for a database.
list_by_location	Lists the long term retention backups for a given location.
list_by_resource_group_database	Lists all long term retention backups for a database based on a particular resource group.
list_by_resource_group_location	Lists the long term retention backups for a given location based on resource group.
list_by_resource_group_server	Lists the long term retention backups for a given server based on resource groups.
list_by_server	Lists the long term retention backups for a given server.

begin_change_access_tier

Change a long term retention backup access tier.

async begin_change_access_tier(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.ChangeLongTermRetentionBackupAccessTierParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str Required.
long_term_retention_server_name Required	str Required.
long_term_retention_database_name Required	str Required.
backup_name Required	str Required.
parameters Required	ChangeLongTermRetentionBackupAccessTierParameters or IO[bytes] Is either a ChangeLongTermRetentionBackupAccessTierParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_change_access_tier_by_resource_group

Change a long term retention backup access tier.

async begin_change_access_tier_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.ChangeLongTermRetentionBackupAccessTierParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackup]

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.
location_name Required	str Required.
long_term_retention_server_name Required	str Required.
long_term_retention_database_name Required	str Required.
backup_name Required	str Required.
parameters Required	ChangeLongTermRetentionBackupAccessTierParameters or IO[bytes] Is either a ChangeLongTermRetentionBackupAccessTierParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_copy

Copy an existing long term retention backup.

async begin_copy(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.CopyLongTermRetentionBackupParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackupOperationResult]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.
parameters Required	CopyLongTermRetentionBackupParameters or IO[bytes] The parameters needed for long term retention copy request. Is either a CopyLongTermRetentionBackupParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackupOperationResult]	An instance of AsyncLROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_copy_by_resource_group

Copy an existing long term retention backup to a different server.

async begin_copy_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.CopyLongTermRetentionBackupParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackupOperationResult]

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.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.
parameters Required	CopyLongTermRetentionBackupParameters or IO[bytes] The parameters needed for long term retention copy request. Is either a CopyLongTermRetentionBackupParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackupOperationResult]	An instance of AsyncLROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a long term retention backup.

async begin_delete(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_by_resource_group

Deletes a long term retention backup.

async begin_delete_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **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. Required.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_lock_time_based_immutability

Lock time based immutability of an existing long term retention backup.

async begin_lock_time_based_immutability(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_lock_time_based_immutability_by_resource_group

Lock time based immutability of an existing long term retention backup.

async begin_lock_time_based_immutability_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the database. Required.
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_remove_legal_hold_immutability

Remove legal hold immutability of an existing long term retention backup.

async begin_remove_legal_hold_immutability(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_remove_legal_hold_immutability_by_resource_group

Remove legal hold immutability of an existing long term retention backup.

async begin_remove_legal_hold_immutability_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the database. Required.
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_remove_time_based_immutability

Remove time based immutability of an existing long term retention backup.

async begin_remove_time_based_immutability(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_remove_time_based_immutability_by_resource_group

Remove time based immutability of an existing long term retention backup.

async begin_remove_time_based_immutability_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the database. Required.
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_set_legal_hold_immutability

Set legal hold immutability of an existing long term retention backup.

async begin_set_legal_hold_immutability(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_set_legal_hold_immutability_by_resource_group

Set legal hold immutability of an existing long term retention backup.

async begin_set_legal_hold_immutability_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> AsyncLROPoller[LongTermRetentionBackup]

Parameters

Name	Description
resource_group_name Required	str The resource group name of the database. Required.
location_name Required	str Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackup]	An instance of AsyncLROPoller that returns either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing long term retention backup.

async begin_update(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.UpdateLongTermRetentionBackupParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackupOperationResult]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.
parameters Required	UpdateLongTermRetentionBackupParameters or IO[bytes] The requested backup resource state. Is either a UpdateLongTermRetentionBackupParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackupOperationResult]	An instance of AsyncLROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_by_resource_group

Updates an existing long term retention backup.

async begin_update_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.UpdateLongTermRetentionBackupParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.LongTermRetentionBackupOperationResult]

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.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.
parameters Required	UpdateLongTermRetentionBackupParameters or IO[bytes] The requested backup resource state. Is either a UpdateLongTermRetentionBackupParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[LongTermRetentionBackupOperationResult]	An instance of AsyncLROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a long term retention backup.

async get(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> LongTermRetentionBackup

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
LongTermRetentionBackup	LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_by_resource_group

Gets a long term retention backup.

async get_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> LongTermRetentionBackup

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.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
backup_name Required	str The backup name. Required.

Returns

Type	Description
LongTermRetentionBackup	LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

Lists all long term retention backups for a database.

list_by_database(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[LongTermRetentionBackup]	An iterator like instance of either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_location

Lists the long term retention backups for a given location.

list_by_location(location_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[LongTermRetentionBackup]	An iterator like instance of either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_database

Lists all long term retention backups for a database based on a particular resource group.

list_by_resource_group_database(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

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.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
long_term_retention_database_name Required	str The name of the database. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[LongTermRetentionBackup]	An iterator like instance of either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_location

Lists the long term retention backups for a given location based on resource group.

list_by_resource_group_location(resource_group_name: str, location_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

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.
location_name Required	str The location of the database. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[LongTermRetentionBackup]	An iterator like instance of either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_server

Lists the long term retention backups for a given server based on resource groups.

list_by_resource_group_server(resource_group_name: str, location_name: str, long_term_retention_server_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

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.
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[LongTermRetentionBackup]	An iterator like instance of either LongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Lists the long term retention backups for a given server.

list_by_server(location_name: str, long_term_retention_server_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[LongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
long_term_retention_server_name Required	str The name of the server. Required.
only_latest_per_database	bool Whether or not to only get the latest backup for each database. Default value is None. Default value: None
database_state	str or DatabaseState Whether to query against just live databases, just deleted databases, or all databases. Known values are: "All", "Live", and "Deleted". Default value is None. Default value: None

Returns

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