Version 1.2.5.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot.

Get-PackageUpdateRule

For AI agents: a documentation index is available at /llms.txt; a markdown version of this page is available at /v1.2.5.0/docs/commands/get-packageupdaterule/index.md.

SYNOPSIS

Get rule(s) for checking and reporting on installed modules

SYNTAX

ShowAll (Default)

Get-PackageUpdateRule [-IncludeModuleForChecking <string>] [-ExcludeModuleFromChecking <string>]
 [-IncludeDefaultRule] [-SettingObject <Configuration>] [<CommonParameters>]

ById

Get-PackageUpdateRule -Id <int[]> [-SettingObject <Configuration>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

This command get the existing custom rule(s) how modules are handled in reporting.

EXAMPLES

EXAMPLE 1

PS C:\> Get-PackageUpdateRule

Get all the existing custom rules

EXAMPLE 2

PS C:\> Get-PackageUpdateRule -Id 1

Get all the custom rule with Id 1

PARAMETERS

-ExcludeModuleFromChecking

ModuleNames to exclude from update checking

Type: String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Exclude
- ExcludeModule
ParameterSets:
- Name: ShowAll
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

The Id as an identifier for the rule

Type: Int32[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ById
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeDefaultRule

Outputs the DefautRule from the setting object, in addition to the customrules

Type: SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ShowAll
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeModuleForChecking

ModuleNames to include from update checking By default all modules are included.

Default value is: “*”

Type: String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Include
- IncludeModule
ParameterSets:
- Name: ShowAll
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SettingObject

Settings object parsed in from command Get-PackageUpdateSetting This is an optional parameter. By default it will use the default settings object from the module.

Type: Configuration
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.