Get-AzureRmRecoveryServicesBackupSchedulePolicyObject

NAME Get-AzureRmRecoveryServicesBackupSchedulePolicyObject



SYNOPSIS

Gets a base schedule policy object.





SYNTAX

Get-AzureRmRecoveryServicesBackupSchedulePolicyObject [-WorkloadType] {AzureVM | AzureSQLDatabase} [[-BackupManagementType] {AzureVM | MARS |

SCDPM | AzureBackupServer | AzureSQL}] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmRecoveryServicesBackupSchedulePolicyObject cmdlet gets a base AzureRMRecoveryServicesSchedulePolicyObject . This object is not

persisted in the system. It is temporary object that you can manipulate and use with the New-AzureRmRecoveryServicesBackupProtectionPolicy cmdlet

to create a new backup protection policy.





PARAMETERS

-BackupManagementType <BackupManagementType>

Specifies the Backup management type. The acceptable values for this parameter are:



- AzureVM



- AzureSQLDatabase



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WorkloadType <WorkloadType>

Specifies the workload type. The acceptable values for this parameter are:



- AzureVM



- AzureSQLDatabase



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.SchedulePolicyBase







NOTES









Example 1: Set the schedule frequency to weekly



PS C:\\>$RetPol = Get-AzureRmRecoveryServicesBackupRetentionPolicyObject -WorkloadType "AzureVM"

PS C:\\> $SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM"

PS C:\\> $SchPol.ScheduleRunFrequency = "Weekly"

PS C:\\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol



The first command gets the retention policy object, and then stores it in the $RetPol variable.



The second command gets the schedule policy object, and then stores it in the $SchPol variable.



The third command changes the frequency for the schedule policy to weekly.



The last command creates a backup protection policy with the updated schedule.





Example 2: Set the backup time



PS C:\\>$SchPol = Get-AzureRmRecoveryServicesBackupSchedulePolicyObject -WorkloadType "AzureVM"

PS C:\\> $SchPol.ScheduleRunTimes.RemoveAll()

PS C:\\> $DT = Get-Date

PS C:\\> $SchPol.ScheduleRunTimes.Add($DT.ToUniversalTime())

PS C:\\> New-AzureRmRecoveryServicesBackupProtectionPolicy -Name "NewPolicy" -WorkloadType AzureVM -RetentionPolicy $RetPol -SchedulePolicy $SchPol



The first command gets the schedule policy object, and then stores it in the $SchPol variable.



The second command removes all scheduled run times from $SchPol.



The third command gets the current date and time, and then stores it in the $DT variable.



The fourth command replaces the scheduled run times with the current time. You can only backup AzureVM once per day, so to reset the backup time

you must replace the original schedule.



The last command creates a backup protection policy using the new schedule.







RELATED LINKS

Online Version:

https://docs.microsoft.com/en-us/powers ... licyobject

New-AzureRmRecoveryServicesBackupProtectionPolicy

Set-AzureRmRecoveryServicesBackupProtectionPolicy