Share via

BackupShortTermRetentionPoliciesOperations Class

  • Reference

BackupShortTermRetentionPoliciesOperations 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.object
BackupShortTermRetentionPoliciesOperations

Constructor

BackupShortTermRetentionPoliciesOperations(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_create_or_update

Updates a database's short term retention policy.
begin_update

Updates a database's short term retention policy.
get

Gets a database's short term retention policy.
list_by_database

Gets a database's short term retention policy.

begin_create_or_update

Updates a database's short term retention policy.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: str | '_models.ShortTermRetentionPolicyName', parameters: '_models.BackupShortTermRetentionPolicy', **kwargs: Any) -> LROPoller['_models.BackupShortTermRetentionPolicy']

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

The name of the server.
database_name
Required
str

The name of the database.
policy_name
Required
str or ShortTermRetentionPolicyName

The policy name. Should always be "default".
parameters
Required
BackupShortTermRetentionPolicy

The short term retention policy info.

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

An instance of LROPoller that returns either BackupShortTermRetentionPolicy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates a database's short term retention policy.

begin_update(resource_group_name: str, server_name: str, database_name: str, policy_name: str | '_models.ShortTermRetentionPolicyName', parameters: '_models.BackupShortTermRetentionPolicy', **kwargs: Any) -> LROPoller['_models.BackupShortTermRetentionPolicy']

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

The name of the server.
database_name
Required
str

The name of the database.
policy_name
Required
str or ShortTermRetentionPolicyName

The policy name. Should always be "default".
parameters
Required
BackupShortTermRetentionPolicy

The short term retention policy info.

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

An instance of LROPoller that returns either BackupShortTermRetentionPolicy or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets a database's short term retention policy.

get(resource_group_name: str, server_name: str, database_name: str, policy_name: str | '_models.ShortTermRetentionPolicyName', **kwargs: Any) -> _models.BackupShortTermRetentionPolicy

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

The name of the server.
database_name
Required
str

The name of the database.
policy_name
Required
str or ShortTermRetentionPolicyName

The policy name. Should always be "default".

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
BackupShortTermRetentionPolicy

BackupShortTermRetentionPolicy, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_database

Gets a database's short term retention policy.

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) -> Iterable['_models.BackupShortTermRetentionPolicyListResult']

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

The name of the server.
database_name
Required
str

The name of the database.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ItemPaged[BackupShortTermRetentionPolicyListResult]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>