LongTermRetentionBackupsOperations Class
LongTermRetentionBackupsOperations 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.objectLongTermRetentionBackupsOperations
Constructor
LongTermRetentionBackupsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| 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_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. |
| list_by_resource_group_location |
Lists the long term retention backups for a given location. |
| list_by_resource_group_server |
Lists the long term retention backups for a given server. |
| list_by_server |
Lists the long term retention backups for a given server. |
begin_copy
Copy an existing long term retention backup.
begin_copy(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.CopyLongTermRetentionBackupParameters, **kwargs: Any) -> LROPoller[_models.LongTermRetentionBackupOperationResult]Parameters
- parameters
- CopyLongTermRetentionBackupParameters
The parameters needed for long term retention copy request.
- 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
An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)
Return type
Exceptions
begin_copy_by_resource_group
Copy an existing long term retention backup to a different server.
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, **kwargs: Any) -> LROPoller[_models.LongTermRetentionBackupOperationResult]Parameters
- resource_group_name
- 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.
- parameters
- CopyLongTermRetentionBackupParameters
The parameters needed for long term retention copy request.
- 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
An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a long term retention backup.
begin_delete(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_delete_by_resource_group
Deletes a long term retention backup.
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) -> LROPoller[None]Parameters
- resource_group_name
- 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.
- 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
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates an existing long term retention backup.
begin_update(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.UpdateLongTermRetentionBackupParameters, **kwargs: Any) -> LROPoller[_models.LongTermRetentionBackupOperationResult]Parameters
- 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
An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)
Return type
Exceptions
begin_update_by_resource_group
Updates an existing long term retention backup.
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, **kwargs: Any) -> LROPoller[_models.LongTermRetentionBackupOperationResult]Parameters
- resource_group_name
- 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.
- 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
An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)
Return type
Exceptions
get
Gets a long term retention backup.
get(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) -> _models.LongTermRetentionBackupParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LongTermRetentionBackup, or the result of cls(response)
Return type
Exceptions
get_by_resource_group
Gets a long term retention backup.
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) -> _models.LongTermRetentionBackupParameters
- resource_group_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LongTermRetentionBackup, or the result of cls(response)
Return type
Exceptions
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: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
list_by_location
Lists the long term retention backups for a given location.
list_by_location(location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group_database
Lists all long term retention backups for a database.
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: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- resource_group_name
- 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.
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group_location
Lists the long term retention backups for a given location.
list_by_resource_group_location(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- resource_group_name
- 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.
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group_server
Lists the long term retention backups for a given server.
list_by_resource_group_server(resource_group_name: str, location_name: str, long_term_retention_server_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- resource_group_name
- 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.
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
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: Optional[bool] = None, database_state: Optional[Union[str, _models.DatabaseState]] = None, **kwargs: Any) -> Iterable[_models.LongTermRetentionBackupListResult]Parameters
- only_latest_per_database
- bool
Whether or not to only get the latest backup for each database.
- database_state
- str or DatabaseState
Whether to query against just live databases, just deleted databases, or all databases.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>Feedback
Submit and view feedback for