Get-PSRuleHelp#
SYNOPSIS#
Displays information about a rule.
SYNTAX#
Get-PSRuleHelp [-Module <String>] [-Online] [-Full] [[-Name] <String[]>] [-Path <String>]
[-Option <PSRuleOption>] [-Culture <String>] [<CommonParameters>]
DESCRIPTION#
The Get-PSRuleHelp cmdlet display information about a rule.
By default, this cmdlet will look for rules in the current path and loaded modules.
To get help for a specific rule or module use the -Name or -Module parameters.
If the rule has an online version of the documentation, use the -Online parameter to view it in your default web browser.
EXAMPLES#
Example 1#
Get-PSRuleHelp;
Get a list of rule help within the current path or loaded modules.
Example 2#
Get-PSRuleHelp Azure.ACR.AdminUser;
Get rule documentation for the rule Azure.ACR.AdminUser.
Example 3#
Get-PSRuleHelp Azure.ACR.AdminUser -Online;
Browse to the online version of documentation for Azure.ACR.AdminUser using the default web browser.
PARAMETERS#
-Name#
The name of the rule to get documentation for.
Type: String[]
Parameter Sets: (All)
Aliases: n
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Path#
A path to check documentation for.
By default, help from the current working path and loaded modules is listed.
Results can be filtered by using -Name, -Path or -Module.
Type: String
Parameter Sets: (All)
Aliases: p
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Module#
Limit returned information to rules in the specified module.
By default, help from the current working path and loaded modules is listed.
Results can be filtered by using -Name, -Path or -Module.
Type: String
Parameter Sets: (All)
Aliases: m
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Culture#
Specifies the culture to use for rule documentation and messages. By default, the culture of PowerShell is used.
This option does not affect the culture used for the PSRule engine, which always uses the culture of PowerShell.
The PowerShell cmdlet Get-Culture shows the current culture of PowerShell.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Online#
Instead of displaying documentation within PowerShell, browse to the online version using the default web browser.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Full#
Display additional information such as notes and links.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Option#
Additional options that configure execution.
A PSRuleOption can be created by using the New-PSRuleOption cmdlet.
Alternatively a hashtable or path to YAML file can be specified with options.
For more information on PSRule options see about_PSRule_Options.
Type: PSRuleOption
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters#
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.