Share via

LongTermRetentionManagedInstanceBackupsOperations Class

LongTermRetentionManagedInstanceBackupsOperations 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.

Constructor

LongTermRetentionManagedInstanceBackupsOperations(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_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.

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

Parameters

Name Description
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
backup_name
Required
str

The backup name.

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 PollingMethod

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

An instance of LROPoller 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.

begin_delete_by_resource_group(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) -> LROPoller[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.
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
backup_name
Required
str

The backup name.

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 PollingMethod

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

An instance of LROPoller 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.

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

Parameters

Name Description
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
backup_name
Required
str

The backup name.

Keyword-Only Parameters

Name Description
cls
callable

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

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.

get_by_resource_group(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) -> _models.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.
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
backup_name
Required
str

The backup name.

Keyword-Only Parameters

Name Description
cls
callable

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

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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

Parameters

Name Description
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult 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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

Parameters

Name Description
location_name
Required
str

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult 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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

Parameters

Name Description
location_name
Required
str

The location of the database.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult 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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

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

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
database_name
Required
str

The name of the managed database.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult 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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

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

The location of the database.
managed_instance_name
Required
str

The name of the managed instance.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult 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 | '_models.DatabaseState' | None = None, **kwargs: Any) -> Iterable['_models.ManagedInstanceLongTermRetentionBackupListResult']

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

The location of the database.
only_latest_per_database
bool

Whether or not to only get the latest backup for each database.

Default value: None
database_state
str or DatabaseState

Whether to query against just live databases, just deleted databases, or all databases.

Default value: None

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv223\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>