Share via

Remove-OBFileSpec

  • Reference
Module:
MSOnlineBackup

Removes the list of items to include or exclude from a backup, as specified by the OBFileSpec object, from a backup policy (OBPolicy) object.

Syntax

Remove-OBFileSpec
      [-Policy] <CBPolicy>
      [-FileSpec] <CBFileSpec[]>
      [-Confirm]
      [-WhatIf]

Description

The Remove-OBFileSpec cmdlet removes the list of items to include or exclude from a backup, as specified by the OBFileSpec object, from a backup policy (OBPolicy object). After making changes to the policy object, Set-OBPolicy must be called to set this policy as the current one.

This cmdlet supports WhatIf and Confirm parameters with a medium impact. The medium impact signifies that the cmdlet will not prompt the user by default. The WhatIf parameter gives a verbose description of what the cmdlet does. 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-OBFileSpec -Policy $policy | Remove-OBFileSpec -Policy $policy

This example removes an existing file specification.

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

-FileSpec

Specifies the items to remove from the OBPolicy object.

Type:CBFileSpec[]
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Policy

Specifies the policy from which the file specification should be deleted.

Type:CBPolicy
Position:2
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.Commands.OBPolicy