CostEstimationPolicyFromClientV2

The following properties represent the CostEstimationPolicyFromClientV2 JSON schema.

CostEstimationPolicyFromClientV2CostEstimationPolicyFromClientV2

Property

Type

Description

priority

integer($int64)

Priority order number of the backup policy.

tenantId

string

Azure ID assigned to a tenant.

regions

PolicyRegionFromClientV2

Information on Azure regions added to the backup policy.

selectedItems

PolicyBackupItemsFromClientV2

Information on items added to the the backup policy.

excludedItems

PolicyExcludedItemsFromClientV2

Information on items excluded from the backup policy.

name

string

Name of the backup policy.

description

string

Description of the backup policy.

retrySettings

RetrySettingsV2

Retry settings configured for the backup policy.

policyNotificationSettings

PolicyNotificationSettingsV2

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

SnapshotSettingsV2

Cloud-native snapshot settings configured for the backup policy.

dailySchedule

DailyScheduleV2

Backup daily schedule settings configured for the backup policy.

weeklySchedule

WeeklyScheduleV2

Backup weekly schedule settings configured for the backup policy.

monthlySchedule

MonthlyScheduleV2

Backup monthly schedule settings configured for the backup policy.

yearlySchedule

YearlyScheduleV2

Backup yearly schedule settings configured for the backup policy.

CostEstimationPolicyFromClientV2PolicyRegionFromClientV2

Property

Type

Description

id

string

Azure ID assigned to the regions added to the backup policy.

CostEstimationPolicyFromClientV2PolicyBackupItemsFromClientV2

Property

Type

Description

subscriptions

PolicySubscriptionFromClientV2

 

tags

TagFromClientV2

 

resourceGroups

PolicyResourceGroupFromClientV2

 

virtualMachines

PolicyVirtualMachineFromClientV2

 

CostEstimationPolicyFromClientV2RetrySettingsV2

Property

Type

Description

retryCount

integer($int32)

Maximum number of retry attempts specified for the backup policy.

CostEstimationPolicyFromClientV2PolicyNotificationSettingsV2

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.

CostEstimationPolicyFromClientV2SnapshotSettingsV2

Property

Type

Description

additionalTags

TagFromClientV2

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

UserScriptsV2

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

CostEstimationPolicyFromClientV2TagFromClientV2

Property

Type

Description

name

string

Name of the tag.

value

string

Value of the tag.

CostEstimationPolicyFromClientV2UserScriptsV2

Property

Type

Description

windows

UserScriptsSettingsV2

Specifies guest scripting settings for windows-based Azure VMs.

linux

UserScriptsSettingsV2

Specifies guest scripting options for linux-based Azure VMs.

CostEstimationPolicyFromClientV2UserScriptsSettingsV2

Property

Type

Description

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.

CostEstimationPolicyFromClientV2DailyScheduleV2

Property

Type

Description

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

DailySnapshotScheduleV2

Daily schedule settings for cloud-native snapshots.

backupSchedule

DailyBackupScheduleV2

Daily schedule settings for image-level backups.

CostEstimationPolicyFromClientV2DailySnapshotScheduleV2

Property

Type

Description

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.

CostEstimationPolicyFromClientV2DailyBackupScheduleV2

Property

Type

Description

hours

integer($int32)

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

retention

RepositoryRetentionSettingsV2

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

targetRepositoryId

string

System ID assigned to the target backup repository.

CostEstimationPolicyFromClientV2WeeklyScheduleV2

Property

Type

Description

startTime

integer($int32)

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

snapshotSchedule

WeeklySnapshotScheduleV2

Weekly schedule settings for cloud-native snapshots.

backupSchedule

WeeklyBackupScheduleV2

Weekly schedule settings for image-level backups.

CostEstimationPolicyFromClientV2WeeklySnapshotScheduleV2

Property

Type

Description

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.

CostEstimationPolicyFromClientV2WeeklyBackupScheduleV2

Property

Type

Description

selectedDays

string

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

retention

RepositoryRetentionSettingsV2

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

targetRepositoryId

string

System ID assigned to the target backup repository.

CostEstimationPolicyFromClientV2MonthlyScheduleV2

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.

snapshotSchedule

MonthlySnapshotScheduleV2

Monthly schedule settings for cloud-native snapshots.

backupSchedule

MonthlyBackupScheduleV2

Monthly schedule settings for image-level backups.

CostEstimationPolicyFromClientV2MonthlySnapshotScheduleV2

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.

snapshotsToKeep

integer($int32)

Number of restore points to keep in a backup chain.

CostEstimationPolicyFromClientV2MonthlyBackupScheduleV2

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

RepositoryRetentionSettingsV2

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

targetRepositoryId

string

System ID assigned to the target backup repository.

CostEstimationPolicyFromClientV2YearlyScheduleV2

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.

CostEstimationPolicyFromClientV2RepositoryRetentionSettingsV2

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.

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.