GetARMBackupPolicy (AZURE Backup Policy)

This method is used to return the list of backup policies of Azure platform created in HCL BigFix CLM.

Method Signature:

GetARMBackupPolicy(recoveryVault, backupPolicyName, controlId, async, servicePlanId, callback, addlparam)

Sample Response:

[{"EntityID":"RBPP-F1139010-F70C-4570-A0F2-0B4A5EB2F86B",
"Name":"daily-backup","ID":"1","RecoveryVaultName":" -recovery-vault",
"ActualIDOnEnvironment":"daily-backup","BackupFrequency":"Daily","BackupTime":"16:00:00","RetentionDailyBackup":"Y","RetentionDailyBackupPointForDays":"7","RetentionWeeklyBackup":"N","RetentionWeeklyBackupOn":"","RetentionWeeklyBackupAt":"","RetentionWeeklyBackupPointForWeeks":"12","RetentionMonthlyBackup":"N","RetentionMonthlyBackupBase":"","RetentionMonthlyBackupOn":"","RetentionMonthlyBackupDay":"","RetentionMonthlyBackupAt":"","RetentionMonthlyBackupPointForMonths":"60","RetentionYearlyBackup":"N","RetentionYearlyBackupBase":"","RetentionYearlyBackupIn":"","RetentionYearlyBackupOn":"","RetentionYearlyBackupDay":"","RetentionYearlyBackupAt":"","RetentionYearlyBackupPointForYears":"10","IsActive":"Y","PlatformEntityID":"ARM-EF5CA4B6-67BE-4B48-BA7C-5F6FC4DAEA3E","RegionName":"eastus","text":"daily-backup"}]

Parameter Details:

Table 1. GetARMBackupPolicy
Parameter Name Type Mandatory Description
recoveryVault String Y Details of passed recovery vault’s backup policy are returned.
backupPolicyName String N

If backup policy is passed, then details of passed backup policy are returned.

If blank “” is passed, then detail of all AZURE’s backup policy will be returned/bind to the control.
controlId String N

Id of ‘Select’ control to be populated.

If Id Control of dynamic UI is passed, then control will be populated with values return from this function else “Result set” will be returned in JSON format.
async Boolean N

In case it’s False:

Function will be called in synchronous mode. i.e., Current execution will wait for method execution to complete

In case it’s True:

Function will be called asynchronously. Execution will not wait for method execution completion. It will jump to next statement.
servicePlanId String N Service Plan ID is Unique ID.
callback Function N User can pass function name that can be executed on completion of Parent function call.
addlparam Object N

Addlparam is used for filtering and sorting the records. It contains 3 properties filter/sortby/sortorder.

To Filter:

To filter records based on column name received from output. e.g., filter="keyname='keyvalue'"

To Sort By:

To sort the data based on column name. e.g., sortby="keyname"

To Sort Order:

To define sorting order either ASC (Ascending) or DESC (descending). e.g., sortorder="ASC”