LongTermRetentionPolicy interface

Package:
@azure/arm-sql

A long term retention policy.

Extends
ProxyResource

Properties

monthlyRetention

The monthly retention policy for an LTR backup in an ISO 8601 format.
timeBasedImmutability

The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled.
timeBasedImmutabilityMode

The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked.
weeklyRetention

The weekly retention policy for an LTR backup in an ISO 8601 format.
weekOfYear

The week of year to take the yearly backup in an ISO 8601 format.
yearlyRetention

The yearly retention policy for an LTR backup in an ISO 8601 format.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

monthlyRetention

The monthly retention policy for an LTR backup in an ISO 8601 format.

monthlyRetention?: string

Property Value

string

timeBasedImmutability

The setting for whether to enable time-based immutability for future backups. When set, future backups will have TimeBasedImmutability enabled.

timeBasedImmutability?: string

Property Value

string

timeBasedImmutabilityMode

The setting for time-based immutability mode for future backup (Value can be either Locked or UnLocked. Only effective if TimeBasedImmutability is enabled). Caution: Immutability of LTR backup cannot be removed if TimeBasedImmutabilityMode is Locked.

timeBasedImmutabilityMode?: string

Property Value

string

weeklyRetention

The weekly retention policy for an LTR backup in an ISO 8601 format.

weeklyRetention?: string

Property Value

string

weekOfYear

The week of year to take the yearly backup in an ISO 8601 format.

weekOfYear?: number

Property Value

number

yearlyRetention

The yearly retention policy for an LTR backup in an ISO 8601 format.

yearlyRetention?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type