Backup Policies - List

Service:: Recovery Services - Backup

API Version:: 2025-08-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=2025-08-01

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
vaultName	path	True	string	The name of the VaultResource
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	OData filter options.

Responses

Name	Type	Description
200 OK	ProtectionPolicyResourceList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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=2025-08-01&$filter=backupManagementType eq 'AzureIaasVM'

Sample response

Status code:: 200

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

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=2025-08-01&$filter=backupManagementType eq 'AzureIaasVM'

Sample response

Status code:: 200

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

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=2025-08-01&$filter=backupManagementType eq 'AzureWorkload'

Sample response

Status code:: 200

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

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.
createdByType	The type of identity that created the resource.
DailyRetentionFormat	Daily retention format.
DailyRetentionSchedule	Daily retention schedule.
DailySchedule
Day	Day of the week.
DayOfWeek
ErrorDetail	Error Detail class which encapsulates Code, Message and Recommendations.
ErrorResponse	Error response
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
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 of retention policy.
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
systemData	Metadata pertaining to creation and last modification of the resource.
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
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 (int32)	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 (int32)	Instant RP retention policy range in days
policyType	IAASVMPolicyType
protectedItemsCount	integer (int32)	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 (int32)	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 (int32)	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

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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[] (date-time)	Retention times of retention policy.

DailySchedule

Object

Name	Type	Description
scheduleRunTimes	string[] (date-time)	List of times of day this schedule has to be run.

Day

Object

Day of the week.

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

DayOfWeek

Enumeration

Value	Description
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday

ErrorDetail

Object

Error Detail class which encapsulates Code, Message and Recommendations.

Name	Type	Description
code	string	Error code.
message	string	Error Message related to the Code.
recommendations	string[]	List of recommendation strings.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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 (int32)	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 (int32)	Interval at which backup needs to be triggered. For hourly the value can be 4/6/8/12
scheduleWindowDuration	integer (int32)	To specify duration of the backup window
scheduleWindowStartTime	string (date-time)	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 (int32)	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 (int32)	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[] (date-time)	Retention times of retention policy.

MonthOfYear

Enumeration

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

PolicyType

Enumeration

Type of backup policy type

Value	Description
Invalid
Full
Differential
Log
CopyOnlyFull
Incremental
SnapshotFull
SnapshotCopyOnlyFull

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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	ProtectionPolicy: AzureFileShareProtectionPolicy AzureIaaSVMProtectionPolicy AzureSqlProtectionPolicy AzureVmWorkloadProtectionPolicy GenericProtectionPolicy MabProtectionPolicy	ProtectionPolicyResource properties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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 (int32)	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 of retention policy.

Value	Description
Invalid
Days
Weeks
Months
Years

RetentionScheduleFormat

Enumeration

Retention schedule format type for monthly retention policy.

Value	Description
Invalid
Daily
Weekly

ScheduleRunType

Enumeration

Frequency of the schedule operation of this policy.

Value	Description
Invalid
Daily
Weekly
Hourly

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[] (date-time)	List of times of day this schedule has to be run.
scheduleWeeklyFrequency	integer (int32)	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 (int32)
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.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

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
Invalid
TierRecommended
TierAfter
DoNotTier

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 (int32)	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 (int32)

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 (int32)
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[] (date-time)	Retention times of retention policy.

WeeklySchedule

Object

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

WeekOfMonth

Enumeration

Value	Description
First
Second
Third
Fourth
Last
Invalid

WorkloadType

Enumeration

Type of workload for the backup management

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

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[] (date-time)	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

createdByType

DailyRetentionFormat

DailyRetentionSchedule

DailySchedule

Day

DayOfWeek

ErrorDetail

ErrorResponse

GenericProtectionPolicy

HourlySchedule

IAASVMPolicyType

IaasVMSnapshotConsistencyType

InstantRPAdditionalDetails

LogSchedulePolicy

LongTermRetentionPolicy

LongTermSchedulePolicy

MabProtectionPolicy

MonthlyRetentionSchedule

MonthOfYear

PolicyType

ProtectionPolicyResource

ProtectionPolicyResourceList

RetentionDuration

RetentionDurationType

RetentionScheduleFormat

ScheduleRunType

Settings

SimpleRetentionPolicy

SimpleSchedulePolicy

SimpleSchedulePolicyV2

SnapshotBackupAdditionalDetails

SubProtectionPolicy

systemData

TieringMode

TieringPolicy

UserAssignedIdentityProperties

UserAssignedManagedIdentityDetails

VaultRetentionPolicy

WeeklyRetentionFormat

WeeklyRetentionSchedule

WeeklySchedule

WeekOfMonth

WorkloadType

YearlyRetentionSchedule