Get-PackageUpdateSetting

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

SYNOPSIS

Retrieves the PackageUpdateInfo configuration from the module settings file.

SYNTAX

__AllParameterSets

Get-PackageUpdateSetting [[-Path] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Reads the PackageUpdateInfo configuration file and returns the current module behavior settings as a PackageUpdate.Configuration object. The returned object includes the default and custom update rules, the update check interval, and the timestamps of the last and last successful checks.

EXAMPLES

EXAMPLE 1

PS C:\> Get-PackageUpdateSetting

Retrieves the current PackageUpdateInfo settings from the default configuration file.

EXAMPLE 2

PS C:\> Get-PackageUpdateSetting -Path "C:\temp\PackageUpdateInfo.json"

Reads the PackageUpdateInfo configuration from a specific settings file.

EXAMPLE 3

PS C:\> Get-PackageUpdateSetting | Select-Object -ExpandProperty UpdateCheckInterval

Returns the configured update check interval from the current settings.

PARAMETERS

-Path

The full path to the settings file to read.

This parameter is optional. If it is omitted, the function uses the default module settings path: Linux: “$HOME/.config/powershell/PackageUpdateInfo/PackageUpdateInfo_$($PSEdition)$($PSVersionTable.PSVersion.Major).json” Windows: “$HOME\AppData\Local\Microsoft\Windows\PowerShell\PackageUpdateInfo$($PSEdition)_$($PSVersionTable.PSVersion.Major).json”

Type: String
DefaultValue: $script:ModuleSettingPath
SupportsWildcards: false
Aliases:
- FullName
- FilePath
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  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.

OUTPUTS

PackageUpdate.Configuration

NOTES

Version : 1.1.0.0 Author : Andi Bellstedt Date : 2026-06-21 Keywords : PackageUpdateInfo, Update, Module, Setting