This is an archive version of the document. To get the most up-to-date information, see the current version.

PolicySQLV3

The following properties represent the PolicySQLV3 JSON schema.

PolicySQLV3PolicySQLV3

Property

Type

Description

id

string($uuid)

System ID assigned to an Azure SQL backup policy in the Veeam Backup for Microsoft Azure REST API.

priority

integer($int64)

Priority order number of the Azure SQL backup policy.

excludedItemsCount

integer($int32)

Number of items excluded from the Azure SQL backup policy.

tenantId

string

Azure ID assigned to a tenant.

serviceAccountId

string

System ID assigned in the Veeam Backup for Microsoft Azure REST API to an Azure service account whose permissions Veeam Backup for Microsoft Azure uses to access Azure resources and perform Azure SQL backup.

backupStatus

array[string]

Status of the most recent backup session: Canceled, Canceling, Error, NeverExecuted, Pending, Running, RunningWithError, RunningWithWarning, Success, Warning.

nextExecutionTime

string($date-time)

Date and time of the next backup session.

_links

string

A list of methods and operations available for the Azure SQL backup policy in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

name

string

Name of the Azure SQL backup policy.

description

string

Description of the Azure SQL backup policy.

retrySettings

RetrySettingsV2

Retry settings configured for the Azure SQL backup policy.

policyNotificationSettings

PolicyNotificationSettingsV2

Notification settings configured for the Azure SQL backup policy.

isEnabled

boolean

Defines whether the email notifications are enabled.

backupType

array[string]

Specifies the type of the Azure SQL backup policy: AllSubscriptions, SelectedItems.

dailySchedule

DailySqlScheduleV3

Backup daily schedule settings configured for the Azure SQL backup policy.

weeklySchedule

WeeklySqlScheduleV3

Backup weekly schedule settings configured for the Azure SQL backup policy.

monthlySchedule

MonthlySqlScheduleV3

Backup monthly schedule settings configured for the Azure SQL backup policy.

yearlySchedule

YearlyScheduleV2

Backup yearly schedule settings configured for the Azure SQL backup policy.

PolicySQLV3RetrySettingsV2

Property

Type

Description

retryCount

integer($int32)

Maximum number of retry attempts specified for the Azure SQL backup policy.

PolicySQLV3PolicyNotificationSettingsV2

Property

Type

Description

recipient

string

Recipient email address.

notifyOnSuccess

boolean

Defines whether to receive an email notification if a policy completes successfully.

notifyOnWarning

boolean

Defines whether to receive an email notification if a policy completes with a warning.

notifyOnFailure

boolean

Defines whether to receive an email notification if a policy fails.

PolicySQLV3DailySqlScheduleV3

Property

Type

Description

dailyType

string

Days when the Azure SQL backup policy must run: Everyday, WeekDays, SelectedDays.

selectedDays

string

[Applies if the Selected days value is specified for the dailyType parameter] Days of the week when the Azure SQL backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

backupSchedule

DailyBackupSchedulev3

Daily schedule settings for image-level backups.

PolicySQLV3DailyBackupScheduleV2

Property

Type

Description

hours

integer($int32)

Hours when the backup policy must start creating image-level backups.

retention

RepositoryRetentionSettingsv3

Period of time to keep restore points in a backup chain.

targetRepositoryId

string

System ID assigned to the target backup repository.

PolicySQLV3WeeklySqlScheduleV3

Property

Type

Description

startTime

integer($int32)

Date of the backup policy creation or modification and time when the Azure SQL backup policy must run.

backupSchedule

WeeklyBackupSchedulev3

Weekly schedule settings for image-level backups.

PolicySQLV3WeeklyBackupScheduleV2

Property

Type

Description

selectedDays

string

Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

retention

RepositoryRetentionSettingsv3

Period of time to keep restore points in a backup chain.

targetRepositoryId

string

System ID assigned to the target backup repository.

PolicySQLV3MonthlySqlScheduleV3

Property

Type

Description

startTime

integer($int32)

Date of the backup policy creation or modification and time when the backup policy must run.

type

array(string)

Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, SelectedDay.

dayOfWeek

array [string]

[Applies if one of the First, Second, Third, Fourth or Last values is specified for the type parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

dayOfMonth

integer($int32)

[Applies if the SelectedDay value is specified for the type parameter] Ordinal number of the day of the month when the backup policy must run.

monthlyLastDay

boolean

Defines whether the backup policy must run always on last day of the month.

backupSchedule

MonthlyBackupSchedulev3

Monthly schedule settings for image-level backups.

PolicySQLV3MonthlyBackupScheduleV2

Property

Type

Description

selectedMonths

string

Months when the backup policy must start creating cloud-native snapshots: January, February, March, April, May, June, July, August, September, October, November, December.

retention

RepositoryRetentionSettingsv3

Period of time to keep restore points in a backup chain.

targetRepositoryId

string

System ID assigned to the target backup repository.

PolicySQLV3YearlyScheduleV2

Property

Type

Description

startTime

integer($int32)

Date of the backup policy creation or modification and time when the backup policy must run.

month

string

Months when the backup policy must start creating cloud-native snapshots: January, February, March, April, May, June, July, August, September, October, November, December.

type

array(string)

Day of the month when the backup policy must run: First, Second, Third, Fourth, Last, SelectedDay.

dayOfWeek

array [string]

[Applies if one of the First, Second, Third, Fourth or Last values is specified for the type parameter] Days of the week when the backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

dayOfMonth

integer($int32)

[Applies if the SelectedDay value is specified for the type parameter] Ordinal number of the day of the month when the backup policy must run.

yearlyLastDay

boolean

Defines whether the backup policy must run always on last day of the year.

retentionYearsCount

integer($int32)

Number of years to keep restore points in a backup chain.

targetRepositoryId

string

System ID assigned to the target backup repository.

PolicySQLV3RepositoryRetentionSettingsV2

Property

Type

Description

timeRetentionDuration

integer($int32)

Number of days, weeks, months or years to keep restore points in a backup chain.

retentionDurationType RetentionDurationType

string

Type of the period: Days, Months, Years.