PolicyV3

id

string($uuid)

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

priority

integer($int64)

Priority order number of the backup policy.

excludedItemsCount

integer($int32)

Number of items excluded from the backup policy.

snapshotStatus

array[string]

Status of the snapshot creation: Canceled, Canceling, Error, NeverExecuted, Pending, Running, RunningWithError, RunningWithWarning, Success, Warning.

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.

convertedWithLoss

boolean

Defines whether the schedule of the backup policy is impossible to convert to the new format.

isBackupConfigured

boolean

Defines whether the policy settings to create image-level backups are configured.

isScheduleConfigured

boolean

Defines whether the backup schedule is specified for the backup policy.

_links

string

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

serviceAccountId

string

System ID assigned to the service account in the Veeam Backup for Microsoft Azure REST API.

name

string

Name of the backup policy.

description

string

Description of the backup policy.

tenantId

string

Azure ID assigned to a tenant.

retrySettings

RetrySettingsv3

Retry settings configured for the backup policy.

policyNotificationSettings

PolicyNotificationSettingsv3

Notification settings configured for the backup policy.

isEnabled

boolean

Defines whether the email notifications are enabled.

backupType

array[string]

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

snapshotSettings

SnapshotSettingsv3

Cloud-native snapshot settings configured for the backup policy.

dailySchedule

DailySchedulev3

Backup daily schedule settings configured for the backup policy.

weeklySchedule

WeeklySchedulev3

Backup weekly schedule settings configured for the backup policy.

monthlySchedule

MonthlySchedulev3

Backup monthly schedule settings configured for the backup policy.

yearlySchedule

YearlySchedulev3

Backup yearly schedule settings configured for the backup policy.

retryCount

integer($int32)

Maximum number of retry attempts specified for the backup policy.

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.

additionalTags

TagFromClientv3

Specifies tags to be assigned to the snapshots.

copyOriginalTags

boolean

Defines whether to assign to the snapshots tags of virtual disks attached to processed Azure VMs.

applicationAwareSnapshot

boolean

Defines whether to enable application-aware processing for Windows-based Azure VMs running VSS-aware applications.

userScripts

UserScriptsv3

Specifies script settings to be applied before and after the creating snapshot operation.

name

string

Name of the tag.

value

string

Value of the tag.

windows

UserScriptsSettingsv3

Specifies guest scripting settings for windows-based Azure VMs.

linux

UserScriptsSettingsv3

Specifies guest scripting options for linux-based Azure VMs.

scriptsEnabled

boolean

Defines whether to run custom scripts on Azure VMs.

preScriptPath

string

Path to the directory on an Azure VM where the pre-snapshot script reside.

preScriptArguments

string

Specifies arguments to be passed to the pre-snapshot script when the script is executed.

postScriptPath

string

Path to the directory on an Azure VM where the post-snapshot script reside.

postScriptArguments

string

Specifies arguments to be passed to the post-snapshot script when the script is executed.

repositorySnapshotsOnly

boolean

Defines whether to run scripts only when performing a snapshot for the image-level backup operation.

ignoreExitCodes

boolean

Defines whether to continue performing backup if script execution failed with errors.

ignoreMissingScripts

boolean

Defines whether to continue performing backup if scripts are missing on the Azure VM.

dailyType

string

Days when the 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 backup policy must run: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.

runsPerHour

integer($int32)

[Applies only for cloud-native snapshots] Number of cloud-native snapshots that the backup policy must create within an hour (minimum: 1).

snapshotSchedule

DailySnapshotSchedulev3

Daily schedule settings for cloud-native snapshots.

backupSchedule

DailyBackupSchedulev3

Daily schedule settings for image-level backups.

hours

integer($int32)

Hours when the backup policy must start creating cloud-native snapshots.

snapshotsToKeep

integer($int32)

Number of restore points to keep in a backup chain.

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.

startTime

integer($int32)

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

snapshotSchedule

WeeklySnapshotSchedulev3

Weekly schedule settings for cloud-native snapshots.

backupSchedule

WeeklyBackupSchedulev3

Weekly schedule settings for image-level backups.

selectedDays

string

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

snapshotsToKeep

integer($int32)

Number of restore points to keep in a backup chain.

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.

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.

snapshotSchedule

MonthlySnapshotSchedulev3

Monthly schedule settings for cloud-native snapshots.

backupSchedule

MonthlyBackupSchedulev3

Monthly schedule settings for image-level backups.

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.

snapshotsToKeep

integer($int32)

Number of restore points to keep in a backup chain.

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.

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.

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.