Share via

Set-OBSchedule

  • Reference
Module:
MSOnlineBackup

Sets the OBSchedule object, which includes the days of the week and times of day to create daily backups, for the backup policy (OBPolicy object).

Syntax

Set-OBSchedule
   [-Policy] <CBPolicy>
   [-Schedule] <CBSchedule>
   [-Confirm]
   [-WhatIf]

Description

The Set-OBSchedule cmdlet sets the OBSchedule object, which includes the days of the week and times of day to create daily backups, for the backup policy (OBPolicy object).

This cmdlet sets the OBPolicy object with references to the days of the week and times of day to create backups.

This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using -Confirm:$FALSE will override the prompt.

To use Microsoft Azure Backup cmdlets, the user needs to be an administrator on the protected machine.

Examples

EXAMPLE 1

$policy = Get-OBPolicy



Get-OBSchedule $policy | Set-OBSchedule $policy

This example sets a protection policy.

EXAMPLE 2

$sch = New-OBSchedule -DaysOfWeek Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday -TimesOfDay 12:00,16:00,20:00



New-OBPolicy | Set-OBSchedule -Schedule $sch

This example sets a new protection policy.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Policy

Specifies the policy which the schedule is being set.

Type:CBPolicy
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Schedule

Specifies the schedule to be set for the policy.

Type:CBSchedule
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.Internal.CloudBackup.Client.Cmdlets.OBPolicy