Remove-OBFileSpec
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
Default (Default)
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FileSpec
Specifies the items to remove from the OBPolicy object.
Parameter properties
| Type: | CBFileSpec[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Policy
Specifies the policy from which the file specification should be deleted.
Parameter properties
| Type: | CBPolicy |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |