LongTermRetentionManagedInstanceBackupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:long_term_retention_managed_instance_backups> attribute.

Constructor

LongTermRetentionManagedInstanceBackupsOperations(*args, **kwargs)

Methods

begin_delete	Deletes a long term retention backup.
begin_delete_by_resource_group	Deletes a long term retention backup.
get	Gets a long term retention backup for a managed database.
get_by_resource_group	Gets a long term retention backup for a managed database.
list_by_database	Lists all long term retention backups for a managed database.
list_by_instance	Lists the long term retention backups for a given managed instance.
list_by_location	Lists the long term retention backups for managed databases in a given location.
list_by_resource_group_database	Lists all long term retention backups for a managed database.
list_by_resource_group_instance	Lists the long term retention backups for a given managed instance.
list_by_resource_group_location	Lists the long term retention backups for managed databases in a given location.

begin_delete

Deletes a long term retention backup.

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

Parameters

Name	Description
location_name Required	str The location of the database. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the managed 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, managed_instance_name: str, 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.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the managed 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

get

Gets a long term retention backup for a managed database.

async get(location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) -> ManagedInstanceLongTermRetentionBackup

Parameters

Name	Description
location_name Required	str The location of the database. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the managed database. Required.
backup_name Required	str The backup name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_by_resource_group

Gets a long term retention backup for a managed database.

async get_by_resource_group(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) -> ManagedInstanceLongTermRetentionBackup

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_database

Lists all long term retention backups for a managed database.

list_by_database(location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[ManagedInstanceLongTermRetentionBackup]

Parameters

Name	Description
location_name Required	str The location of the database. Required.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the managed 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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_instance

Lists the long term retention backups for a given managed instance.

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

Parameters

Name	Description
location_name Required	str The location of the database. Required.
managed_instance_name Required	str The name of the managed instance. 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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_location

Lists the long term retention backups for managed databases in 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[ManagedInstanceLongTermRetentionBackup]

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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_database

Lists all long term retention backups for a managed database.

list_by_resource_group_database(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: bool | None = None, database_state: str | DatabaseState | None = None, **kwargs: Any) -> AsyncItemPaged[ManagedInstanceLongTermRetentionBackup]

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.
managed_instance_name Required	str The name of the managed instance. Required.
database_name Required	str The name of the managed 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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_instance

Lists the long term retention backups for a given managed instance.

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

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.
managed_instance_name Required	str The name of the managed instance. 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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group_location

Lists the long term retention backups for managed databases in a given location.

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

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[ManagedInstanceLongTermRetentionBackup]	An iterator like instance of either ManagedInstanceLongTermRetentionBackup 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'>