Share via

ManagedBackupShortTermRetentionPoliciesOperations Class

ManagedBackupShortTermRetentionPoliciesOperations 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

ManagedBackupShortTermRetentionPoliciesOperations(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 managed database's short term retention policy.
begin_update

Updates a managed database's short term retention policy.
get

Gets a managed database's short term retention policy.
list_by_database

Gets a managed database's short term retention policy list.

begin_create_or_update

Updates a managed database's short term retention policy.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: str | '_models.ManagedShortTermRetentionPolicyName', parameters: '_models.ManagedBackupShortTermRetentionPolicy', **kwargs: Any) -> LROPoller['_models.ManagedBackupShortTermRetentionPolicy']

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

The name of the managed instance.
database_name
Required
str

The name of the database.
policy_name
Required
str or ManagedShortTermRetentionPolicyName

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

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

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

Exceptions

Type Description
HttpResponseError

begin_update

Updates a managed database's short term retention policy.

begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: str | '_models.ManagedShortTermRetentionPolicyName', parameters: '_models.ManagedBackupShortTermRetentionPolicy', **kwargs: Any) -> LROPoller['_models.ManagedBackupShortTermRetentionPolicy']

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

The name of the managed instance.
database_name
Required
str

The name of the database.
policy_name
Required
str or ManagedShortTermRetentionPolicyName

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

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

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

Exceptions

Type Description
HttpResponseError

get

Gets a managed database's short term retention policy.

get(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: str | '_models.ManagedShortTermRetentionPolicyName', **kwargs: Any) -> _models.ManagedBackupShortTermRetentionPolicy

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

The name of the managed instance.
database_name
Required
str

The name of the database.
policy_name
Required
str or ManagedShortTermRetentionPolicyName

The policy name.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ManagedBackupShortTermRetentionPolicy

ManagedBackupShortTermRetentionPolicy, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_database

Gets a managed database's short term retention policy list.

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

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

The name of the managed instance.
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[ManagedBackupShortTermRetentionPolicyListResult]

An iterator like instance of either ManagedBackupShortTermRetentionPolicyListResult 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'>