This is the built-in help made by Microsoft for the command 'Set-BpaResult', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 Standard' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results.
Set-BpaResult [[-Exclude] <Boolean>] [-Results] <List> [[-RepositoryPath] <String>] [<CommonParameters>]
The Set-BPAResult cmdlet excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan
results. The action specified in this cmdlet (such as Exclude) determines how the existing results of a BPA scan are updated. This cmdlet is
typically applied after using the Get-BpaResult cmdlet to return a collection of scan results. Filters can be applied to results returned by
the Get-BpaResult cmdlet, and then pipe the filtered collection of results to this cmdlet, specifying either to include or exclude filtered
scan results.
This will update the results in the result file with the specified result collection with the action specified. The administrator would
generally need to call the Get-BpaResult cmdlet prior to this to get the result collection, apply some filters and pipe the collection to this
cmdlet specifying the action (exclusion or inclusion).
If this cmdlet is canceled before the results are written to a file, then the operation is canceled and the results file is not modified. If
cancellation occurs after the results file has been modified, then the actions of the cmdlet are carried out, and the cmdlet cannot be
canceled.
<
Online Version: http://go.microsoft.com/fwlink/p/?LinkId=141492
Get-BpaModel
Get-BpaResult
Invoke-BpaModel
<
EXAMPLE 1
PS C:\> Get-BPAResult -ModelId ModelId1 | Where-Object -FilterScript { $_.Category -Eq "Performance" } | Set-BPAResult -ModelId ModelId1
-Exclude $true
This example, to the left of the first pipe character (|), uses the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for
the model ID represented by ModelId1. The second section of the cmdlet filters the results of the Get-BpaResult cmdlet to get only those scan
results for which the category name is equal to Performance. The final section of the example, following the second pipe character, excludes
the Performance results filtered by the previous section of the example.
EXAMPLE 2
The variable $rcPolicy is created to store the filtered results of the Get-BpaResult cmdlet; this variable can be used in subsequent cmdlets
to represent those results.
PS C:\> $rcPolicy = Get-BPAResult -ModelId ModelId1 | Where-Object –FilterScript { $_.Category -Eq "Policy" }
The second line of the example uses this cmdlet to exclude the set of results stored in the $rcPolicy variable, for the specified model ID. In
this cmdlet, the Results parameter is added because the administrator wants to exclude a specific subset of scan results for that model, and
has created the variable $rcPolicy to represent that subset of results.
PS C:\> Set-BPAResult -ModelId ModelId1 -Exclude $true -Results $rcPolicy
This example, to the left of the pipe character (|), instructs the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for
the model represented by ModelId1 The second section of the example, after the pipe character, filters the results of the Get-BpaResult cmdlet
to return only those scan results for which the category name is equal to (note the Eq option) Policy.