LongTermRetentionPoliciesOperations Class

LongTermRetentionPoliciesOperations 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

LongTermRetentionPoliciesOperations

Constructor

LongTermRetentionPoliciesOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update	Sets a database's long term retention policy.
get	Gets a database's long term retention policy.
list_by_database	Gets a database's long term retention policy.

begin_create_or_update

Sets a database's long term retention policy.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.LongTermRetentionPolicyName], parameters: _models.LongTermRetentionPolicy, **kwargs: Any) -> LROPoller[_models.LongTermRetentionPolicy]

Parameters

resource_group_name

str

Required

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

str

Required

The name of the server.

database_name

str

Required

The name of the database.

policy_name

str or LongTermRetentionPolicyName

Required

The policy name. Should always be Default.

parameters

LongTermRetentionPolicy

Required

The long term retention policy info.

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 LongTermRetentionPolicy or the result of cls(response)

Return type

LROPoller[LongTermRetentionPolicy]

Exceptions

HttpResponseError

get

Gets a database's long term retention policy.

get(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.LongTermRetentionPolicyName], **kwargs: Any) -> _models.LongTermRetentionPolicy

Parameters

resource_group_name

str

Required

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

str

Required

The name of the server.

database_name

str

Required

The name of the database.

policy_name

str or LongTermRetentionPolicyName

Required

The policy name. Should always be Default.

cls

callable

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

Returns

LongTermRetentionPolicy, or the result of cls(response)

Return type

LongTermRetentionPolicy

Exceptions

HttpResponseError

list_by_database

Gets a database's long term retention policy.

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

Parameters

resource_group_name

str

Required

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

str

Required

The name of the server.

database_name

str

Required

The name of the database.

cls

callable

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

Returns

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

Return type

ItemPaged[LongTermRetentionPolicyListResult]

Exceptions

HttpResponseError

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'>