This is an archive version of the document. To get the most up-to-date information, see the
current version.
CostEstimationPolicyFromClientV2
The following properties represent the CostEstimationPolicyFromClientv3 JSON schema.
CostEstimationPolicyFromClientV2
Property | Type | Description |
|---|
priority | integer($int64) | Priority order number of the backup policy. | tenantId | string | Azure ID assigned to a tenant. | regions | PolicyRegionFromClientv3 | Information on Azure regions added to the backup policy. | selectedItems | PolicyBackupItemsFromClientv3 | Information on items added to the the backup policy. | excludedItems | PolicyExcludedItemsFromClientv3 | Information on items excluded from the backup policy. | name | string | Name of the backup policy. | description | string | Description of the backup policy. | 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. |
|
PolicyRegionFromClientV2
Property | Type | Description |
|---|
id | string | Azure ID assigned to the regions added to the backup policy. |
|
PolicyBackupItemsFromClientV2
Property | Type | Description |
|---|
subscriptions | PolicySubscriptionFromClientv3 | | tags | TagFromClientv3 | | resourceGroups | PolicyResourceGroupFromClientv3 | | virtualMachines | PolicyVirtualMachineFromClientv3 | |
|
RetrySettingsV2
Property | Type | Description |
|---|
retryCount | integer($int32) | Maximum number of retry attempts specified for the backup policy. |
|
PolicyNotificationSettingsV2
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. |
|
SnapshotSettingsV2
Property | Type | Description |
|---|
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. |
|
TagFromClientV2
Property | Type | Description |
|---|
name | string | Name of the tag. | value | string | Value of the tag. |
|
UserScriptsV2
UserScriptsSettingsV2
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. |
|
DailyScheduleV2
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 | DailySnapshotSchedulev3 | Daily schedule settings for cloud-native snapshots. | backupSchedule | DailyBackupSchedulev3 | Daily schedule settings for image-level backups. |
|
DailySnapshotScheduleV2
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. |
|
DailyBackupScheduleV2
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. |
|
WeeklyScheduleV2
Property | Type | Description |
|---|
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. |
|
WeeklySnapshotScheduleV2
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. |
|
WeeklyBackupScheduleV2
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. |
|
MonthlyScheduleV2
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 | MonthlySnapshotSchedulev3 | Monthly schedule settings for cloud-native snapshots. | backupSchedule | MonthlyBackupSchedulev3 | Monthly schedule settings for image-level backups. |
|
MonthlySnapshotScheduleV2
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. |
|
MonthlyBackupScheduleV2
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. |
|
YearlyScheduleV2
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. |
|
RepositoryRetentionSettingsV2
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. |
|