Add-OBFileSpec
Adds the OBFileSpec object, which specifies the items to include or exclude from a backup, to the backup policy (OBPolicy object).
Syntax
Default (Default)
Add-OBFileSpec
[-Policy] <CBPolicy>
[-FileSpec] <CBFileSpec[]>
[-Confirm]
[-WhatIf]
Description
The Add-OBFileSpec cmdlet adds the OBFileSpec object, which specifies the items to include or exclude from a backup, to the backup policy (OBPolicy object). The OBFileSpec object can include or exclude multiple files, folders, or volumes. The list of items to include can be defined by using the New-OBFileSpec cmdlet and then update the OBPolicy object using this cmdlet. The Add-OBFileSpec cmdlet supports WhatIf and Confirm parameters with a low impact. The low 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
New-OBFileSpec -FileSpec "C:\testdata" -NonRecursive | Add-OBFileSpec -Policy $policy
This example adds a file specification.
EXAMPLE 2
$fspec = New-OBFileSpec -FileSpec C:\testdata -NonRecursive
New-OBPolicy | Add-OBFileSpec -FileSpec $fspec
This example adds a 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 OBFileSpec object to add to the backup policy.
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 backup policy (OBPolicy object) to update.
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 |