Backup Policies - List

Reference

Service:: Recovery Services - Backup

API Version:: 2024-10-01

Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies?api-version=2024-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies?api-version=2024-10-01&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
subscriptionId	path	True	string	The subscription Id.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string	Client Api Version.
$filter	query		string	OData filter options.

Responses

Name	Type	Description
200 OK	ProtectionPolicyResourceList	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

List protection policies with backupManagementType filter as AzureIaasVm

List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies

List protection policies with backupManagementType filter as AzureWorkload

List protection policies with backupManagementType filter as AzureIaasVm

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2024-10-01&$filter=backupManagementType eq 'AzureIaasVM'

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
      "name": "DefaultPolicy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2017-12-05T19:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2017-12-05T19:00:00Z"
            ],
            "retentionDuration": {
              "count": 30,
              "durationType": "Days"
            }
          }
        },
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
      "name": "testPolicy1",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2018-01-24T02:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    }
  ]
}

List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2024-10-01&$filter=backupManagementType eq 'AzureIaasVM'

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy",
      "name": "DefaultPolicy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2017-12-05T19:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2017-12-05T19:00:00Z"
            ],
            "retentionDuration": {
              "count": 30,
              "durationType": "Days"
            }
          }
        },
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
      "name": "testPolicy1",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicy",
          "scheduleRunFrequency": "Daily",
          "scheduleRunTimes": [
            "2018-01-24T02:00:00Z"
          ],
          "scheduleWeeklyFrequency": 0
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    },
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-policy",
      "name": "v2-daily-policy",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureIaasVM",
        "schedulePolicy": {
          "schedulePolicyType": "SimpleSchedulePolicyV2",
          "scheduleRunFrequency": "Daily",
          "dailySchedule": {
            "scheduleRunTimes": [
              "2018-01-24T10:00:00Z"
            ]
          }
        },
        "retentionPolicy": {
          "retentionPolicyType": "LongTermRetentionPolicy",
          "dailySchedule": {
            "retentionTimes": [
              "2018-01-24T02:00:00Z"
            ],
            "retentionDuration": {
              "count": 1,
              "durationType": "Days"
            }
          }
        },
        "timeZone": "Pacific Standard Time",
        "protectedItemsCount": 0
      }
    }
  ]
}

List protection policies with backupManagementType filter as AzureWorkload

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies?api-version=2024-10-01&$filter=backupManagementType eq 'AzureWorkload'

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/HourlyLogBackup",
      "name": "HourlyLogBackup",
      "type": "Microsoft.RecoveryServices/vaults/backupPolicies",
      "properties": {
        "backupManagementType": "AzureWorkload",
        "workLoadType": "SQLDataBase",
        "settings": {
          "timeZone": "UTC",
          "issqlcompression": false
        },
        "subProtectionPolicy": [
          {
            "policyType": "Full",
            "schedulePolicy": {
              "schedulePolicyType": "SimpleSchedulePolicy",
              "scheduleRunFrequency": "Daily",
              "scheduleRunTimes": [
                "2017-12-05T19:00:00Z"
              ],
              "scheduleWeeklyFrequency": 0
            },
            "retentionPolicy": {
              "retentionPolicyType": "LongTermRetentionPolicy",
              "dailySchedule": {
                "retentionTimes": [
                  "2017-12-05T19:00:00Z"
                ],
                "retentionDuration": {
                  "count": 30,
                  "durationType": "Days"
                }
              }
            }
          },
          {
            "policyType": "Log",
            "schedulePolicy": {
              "schedulePolicyType": "LogSchedulePolicy",
              "scheduleFrequencyInMins": 60
            },
            "retentionPolicy": {
              "retentionPolicyType": "SimpleRetentionPolicy",
              "retentionDuration": {
                "count": 30,
                "durationType": "Days"
              }
            }
          }
        ],
        "protectedItemsCount": 0
      }
    }
  ]
}

Definitions

Name	Description
AzureFileShareProtectionPolicy	AzureStorage backup policy.
AzureIaaSVMProtectionPolicy	IaaS VM workload-specific backup policy.
AzureSqlProtectionPolicy	Azure SQL workload-specific backup policy.
AzureVmWorkloadProtectionPolicy	Azure VM (Mercury) workload-specific backup policy.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
DailyRetentionFormat	Daily retention format.
DailyRetentionSchedule	Daily retention schedule.
DailySchedule
Day	Day of the week.
DayOfWeek
ErrorAdditionalInfo	The resource management error additional info.
GenericProtectionPolicy	Azure VM (Mercury) workload-specific backup policy.
HourlySchedule
IAASVMPolicyType
IaasVMSnapshotConsistencyType
InstantRPAdditionalDetails
LogSchedulePolicy	Log policy schedule.
LongTermRetentionPolicy	Long term retention policy.
LongTermSchedulePolicy	Long term policy schedule.
MabProtectionPolicy	Mab container-specific backup policy.
MonthlyRetentionSchedule	Monthly retention schedule.
MonthOfYear	List of months of year of yearly retention policy.
PolicyType	Type of backup policy type
ProtectionPolicyResource	Base class for backup policy. Workload-specific backup policies are derived from this class.
ProtectionPolicyResourceList	List of ProtectionPolicy resources
RetentionDuration	Retention duration.
RetentionDurationType	Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter
RetentionScheduleFormat	Retention schedule format type for monthly retention policy.
ScheduleRunType	Frequency of the schedule operation of this policy.
Settings	Common settings field for backup management
SimpleRetentionPolicy	Simple policy retention.
SimpleSchedulePolicy	Simple policy schedule.
SimpleSchedulePolicyV2	The V2 policy schedule for IaaS that supports hourly backups.
SnapshotBackupAdditionalDetails	Snapshot Backup related fields for WorkloadType SaPHanaSystem
SubProtectionPolicy	Sub-protection policy which includes schedule and retention
TieringMode	Tiering Mode to control automatic tiering of recovery points. Supported values are: TierRecommended: Tier all recovery points recommended to be tiered TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. DoNotTier: Do not tier any recovery points
TieringPolicy	Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier
UserAssignedIdentityProperties	User assigned managed identity properties
UserAssignedManagedIdentityDetails	User assigned managed identity details
VaultRetentionPolicy	Vault retention policy for AzureFileShare
WeeklyRetentionFormat	Weekly retention format.
WeeklyRetentionSchedule	Weekly retention schedule.
WeeklySchedule
WeekOfMonth	List of weeks of month.
WorkloadType	Type of workload for the backup management
YearlyRetentionSchedule	Yearly retention schedule.

AzureFileShareProtectionPolicy

Object

AzureStorage backup policy.

Name	Type	Description
backupManagementType	string: AzureStorage	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".
vaultRetentionPolicy	VaultRetentionPolicy	Retention policy with the details on hardened backup copy retention ranges.
workLoadType	WorkloadType	Type of workload for the backup management

AzureIaaSVMProtectionPolicy

Object

IaaS VM workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureIaasVM	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
instantRPDetails	InstantRPAdditionalDetails
instantRpRetentionRangeInDays	integer	Instant RP retention policy range in days
policyType	IAASVMPolicyType
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
snapshotConsistencyType	IaasVMSnapshotConsistencyType
tieringPolicy	<string, TieringPolicy>	Tiering policy to automatically move RPs to another tier Key is Target Tier, defined in RecoveryPointTierType enum. Tiering policy specifies the criteria to move RP to the target tier.
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

AzureSqlProtectionPolicy

Object

Azure SQL workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureSql	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy details.

AzureVmWorkloadProtectionPolicy

Object

Azure VM (Mercury) workload-specific backup policy.

Name	Type	Description
backupManagementType	string: AzureWorkload	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
makePolicyConsistent	boolean	Fix the policy inconsistency
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
settings	Settings	Common settings for the backup management
subProtectionPolicy	SubProtectionPolicy[]	List of sub-protection policies which includes schedule and retention
workLoadType	WorkloadType	Type of workload for the backup management

CloudError

Object

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

Object

An error response from the Container Instance service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

DailyRetentionFormat

Object

Daily retention format.

Name	Type	Description
daysOfTheMonth	Day[]	List of days of the month.

DailyRetentionSchedule

Object

Daily retention schedule.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionTimes	string[]	Retention times of retention policy.

DailySchedule

Object

Name	Type	Description
scheduleRunTimes	string[]	List of times of day this schedule has to be run.

Day

Object

Day of the week.

Name	Type	Description
date	integer	Date of the month
isLast	boolean	Whether Date is last date of month

DayOfWeek

Enumeration

Value	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

GenericProtectionPolicy

Object

Azure VM (Mercury) workload-specific backup policy.

Name	Type	Description
backupManagementType	string: GenericProtectionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
fabricName	string	Name of this policy's fabric.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
subProtectionPolicy	SubProtectionPolicy[]	List of sub-protection policies which includes schedule and retention
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

HourlySchedule

Object

Name	Type	Description
interval	integer	Interval at which backup needs to be triggered. For hourly the value can be 4/6/8/12
scheduleWindowDuration	integer	To specify duration of the backup window
scheduleWindowStartTime	string	To specify start time of the backup window

IAASVMPolicyType

Enumeration

Value	Description
Invalid
V1
V2

IaasVMSnapshotConsistencyType

Enumeration

Value	Description
OnlyCrashConsistent

InstantRPAdditionalDetails

Object

Name	Type	Description
azureBackupRGNamePrefix	string
azureBackupRGNameSuffix	string

LogSchedulePolicy

Object

Log policy schedule.

Name	Type	Description
scheduleFrequencyInMins	integer	Frequency of the log schedule operation of this policy in minutes.
schedulePolicyType	string: LogSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

LongTermRetentionPolicy

Object

Long term retention policy.

Name	Type	Description
dailySchedule	DailyRetentionSchedule	Daily retention schedule of the protection policy.
monthlySchedule	MonthlyRetentionSchedule	Monthly retention schedule of the protection policy.
retentionPolicyType	string: LongTermRetentionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
weeklySchedule	WeeklyRetentionSchedule	Weekly retention schedule of the protection policy.
yearlySchedule	YearlyRetentionSchedule	Yearly retention schedule of the protection policy.

LongTermSchedulePolicy

Object

Long term policy schedule.

Name	Type	Description
schedulePolicyType	string: LongTermSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

MabProtectionPolicy

Object

Mab container-specific backup policy.

Name	Type	Description
backupManagementType	string: MAB	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectedItemsCount	integer	Number of items associated with this policy.
resourceGuardOperationRequests	string[]	ResourceGuard Operation Requests
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy details.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule of backup policy.

MonthlyRetentionSchedule

Object

Monthly retention schedule.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionScheduleDaily	DailyRetentionFormat	Daily retention format for monthly retention policy.
retentionScheduleFormatType	RetentionScheduleFormat	Retention schedule format type for monthly retention policy.
retentionScheduleWeekly	WeeklyRetentionFormat	Weekly retention format for monthly retention policy.
retentionTimes	string[]	Retention times of retention policy.

MonthOfYear

Enumeration

List of months of year of yearly retention policy.

Value	Description
April
August
December
February
Invalid
January
July
June
March
May
November
October
September

PolicyType

Enumeration

Type of backup policy type

Value	Description
CopyOnlyFull
Differential
Full
Incremental
Invalid
Log
SnapshotCopyOnlyFull
SnapshotFull

ProtectionPolicyResource

Object

Base class for backup policy. Workload-specific backup policies are derived from this class.

Name	Type	Description
eTag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
location	string	Resource location.
name	string	Resource name associated with the resource.
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	ProtectionPolicyResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

ProtectionPolicyResourceList

Object

List of ProtectionPolicy resources

Name	Type	Description
nextLink	string	The URI to fetch the next page of resources, with each API call returning up to 200 resources per page. Use ListNext() to fetch the next page if the total number of resources exceeds 200.
value	ProtectionPolicyResource[]	List of resources.

RetentionDuration

Object

Retention duration.

Name	Type	Description
count	integer	Count of duration types. Retention duration is obtained by the counting the duration type Count times. For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.
durationType	RetentionDurationType	Retention duration type of retention policy.

RetentionDurationType

Enumeration

Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter

Value	Description
Days
Invalid
Months
Weeks
Years

RetentionScheduleFormat

Enumeration

Retention schedule format type for monthly retention policy.

Value	Description
Daily
Invalid
Weekly

ScheduleRunType

Enumeration

Frequency of the schedule operation of this policy.

Value	Description
Daily
Hourly
Invalid
Weekly

Settings

Object

Common settings field for backup management

Name	Type	Description
isCompression	boolean	Workload compression flag. This has been added so that 'isSqlCompression' will be deprecated once clients upgrade to consider this flag.
issqlcompression	boolean	SQL compression flag
timeZone	string	TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

SimpleRetentionPolicy

Object

Simple policy retention.

Name	Type	Description
retentionDuration	RetentionDuration	Retention duration of the protection policy.
retentionPolicyType	string: SimpleRetentionPolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

SimpleSchedulePolicy

Object

Simple policy schedule.

Name	Type	Description
hourlySchedule	HourlySchedule	Hourly Schedule of this Policy
schedulePolicyType	string: SimpleSchedulePolicy	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
scheduleRunDays	DayOfWeek[]	List of days of week this schedule has to be run.
scheduleRunFrequency	ScheduleRunType	Frequency of the schedule operation of this policy.
scheduleRunTimes	string[]	List of times of day this schedule has to be run.
scheduleWeeklyFrequency	integer	At every number weeks this schedule has to be run.

SimpleSchedulePolicyV2

Object

The V2 policy schedule for IaaS that supports hourly backups.

Name	Type	Description
dailySchedule	DailySchedule	Daily schedule of this policy
hourlySchedule	HourlySchedule	hourly schedule of this policy
schedulePolicyType	string: SimpleSchedulePolicyV2	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
scheduleRunFrequency	ScheduleRunType	Frequency of the schedule operation of this policy.
weeklySchedule	WeeklySchedule	Weekly schedule of this policy

SnapshotBackupAdditionalDetails

Object

Snapshot Backup related fields for WorkloadType SaPHanaSystem

Name	Type	Description
instantRPDetails	string
instantRpRetentionRangeInDays	integer
userAssignedManagedIdentityDetails	UserAssignedManagedIdentityDetails	User assigned managed identity details

SubProtectionPolicy

Object

Sub-protection policy which includes schedule and retention

Name	Type	Description
policyType	PolicyType	Type of backup policy type
retentionPolicy	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Retention policy with the details on backup copy retention ranges.
schedulePolicy	SchedulePolicy: LogSchedulePolicy LongTermSchedulePolicy SimpleSchedulePolicy SimpleSchedulePolicyV2	Backup schedule specified as part of backup policy.
snapshotBackupAdditionalDetails	SnapshotBackupAdditionalDetails	Snapshot Backup related fields for WorkloadType SaPHanaSystem
tieringPolicy	<string, TieringPolicy>	Tiering policy to automatically move RPs to another tier. Key is Target Tier, defined in RecoveryPointTierType enum. Tiering policy specifies the criteria to move RP to the target tier.

TieringMode

Enumeration

Tiering Mode to control automatic tiering of recovery points. Supported values are:

TierRecommended: Tier all recovery points recommended to be tiered
TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.
DoNotTier: Do not tier any recovery points

Value	Description
DoNotTier
Invalid
TierAfter
TierRecommended

TieringPolicy

Object

Tiering Policy for a target tier. If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier

Name	Type	Description
duration	integer	Number of days/weeks/months/years to retain backups in current tier before tiering. Used only if TieringMode is set to TierAfter
durationType	RetentionDurationType	Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter
tieringMode	TieringMode	Tiering Mode to control automatic tiering of recovery points. Supported values are: TierRecommended: Tier all recovery points recommended to be tiered TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. DoNotTier: Do not tier any recovery points

Name

Type

Description

duration

integer

Number of days/weeks/months/years to retain backups in current tier before tiering. Used only if TieringMode is set to TierAfter

durationType

RetentionDurationType

Retention duration type: days/weeks/months/years Used only if TieringMode is set to TierAfter

tieringMode

TieringMode

Tiering Mode to control automatic tiering of recovery points. Supported values are:

TierRecommended: Tier all recovery points recommended to be tiered
TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.
DoNotTier: Do not tier any recovery points

UserAssignedIdentityProperties

Object

User assigned managed identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.

UserAssignedManagedIdentityDetails

Object

User assigned managed identity details

Name	Type	Description
identityArmId	string	The ARM id of the assigned identity.
identityName	string	The name of the assigned identity.
userAssignedIdentityProperties	UserAssignedIdentityProperties	User assigned managed identity properties

VaultRetentionPolicy

Object

Vault retention policy for AzureFileShare

Name	Type	Description
snapshotRetentionInDays	integer
vaultRetention	RetentionPolicy: LongTermRetentionPolicy SimpleRetentionPolicy	Base class for retention policy.

WeeklyRetentionFormat

Object

Weekly retention format.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	List of days of the week.
weeksOfTheMonth	WeekOfMonth[]	List of weeks of month.

WeeklyRetentionSchedule

Object

Weekly retention schedule.

Name	Type	Description
daysOfTheWeek	DayOfWeek[]	List of days of week for weekly retention policy.
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionTimes	string[]	Retention times of retention policy.

WeeklySchedule

Object

Name	Type	Description
scheduleRunDays	DayOfWeek[]
scheduleRunTimes	string[]	List of times of day this schedule has to be run.

WeekOfMonth

Enumeration

List of weeks of month.

Value	Description
First
Fourth
Invalid
Last
Second
Third

WorkloadType

Enumeration

Type of workload for the backup management

Value	Description
AzureFileShare
AzureSqlDb
Client
Exchange
FileFolder
GenericDataSource
Invalid
SAPAseDatabase
SAPHanaDBInstance
SAPHanaDatabase
SQLDB
SQLDataBase
Sharepoint
SystemState
VM
VMwareVM

YearlyRetentionSchedule

Object

Yearly retention schedule.

Name	Type	Description
monthsOfYear	MonthOfYear[]	List of months of year of yearly retention policy.
retentionDuration	RetentionDuration	Retention duration of retention Policy.
retentionScheduleDaily	DailyRetentionFormat	Daily retention format for yearly retention policy.
retentionScheduleFormatType	RetentionScheduleFormat	Retention schedule format for yearly retention policy.
retentionScheduleWeekly	WeeklyRetentionFormat	Weekly retention format for yearly retention policy.
retentionTimes	string[]	Retention times of retention policy.

Share via

Backup Policies - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List protection policies with backupManagementType filter as AzureIaasVm

Sample request

Sample response

List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies

Sample request

Sample response

List protection policies with backupManagementType filter as AzureWorkload

Sample request

Sample response

Definitions

AzureFileShareProtectionPolicy

AzureIaaSVMProtectionPolicy

AzureSqlProtectionPolicy

AzureVmWorkloadProtectionPolicy

CloudError

CloudErrorBody

DailyRetentionFormat

DailyRetentionSchedule

DailySchedule

Day

DayOfWeek

ErrorAdditionalInfo

GenericProtectionPolicy

HourlySchedule

IAASVMPolicyType

IaasVMSnapshotConsistencyType

InstantRPAdditionalDetails

LogSchedulePolicy

LongTermRetentionPolicy

LongTermSchedulePolicy

MabProtectionPolicy

MonthlyRetentionSchedule

MonthOfYear

PolicyType

ProtectionPolicyResource

ProtectionPolicyResourceList

RetentionDuration

RetentionDurationType

RetentionScheduleFormat

ScheduleRunType

Settings

SimpleRetentionPolicy

SimpleSchedulePolicy

SimpleSchedulePolicyV2

SnapshotBackupAdditionalDetails

SubProtectionPolicy

TieringMode

TieringPolicy

UserAssignedIdentityProperties

UserAssignedManagedIdentityDetails

VaultRetentionPolicy

WeeklyRetentionFormat

WeeklyRetentionSchedule

WeeklySchedule

WeekOfMonth

WorkloadType

YearlyRetentionSchedule

Additional resources