Edit

Share via

Set-AppxPackageAutoUpdateSettings

Module:
Appx Module

Configures a specific Windows App's Auto Update and Repair settings.

Syntax

SetAutoUpdateOptionsSet (Default) 

Set-AppxPackageAutoUpdateSettings
    [-PackageFamilyName] <String>
    -AppInstallerUri <String>
    [-UpdateUris <String[]>]
    [-RepairUris <String[]>]
    [-OptionalPackages <String[]>]
    [-DependencyPackages <String[]>]
    [-EnableAutomaticBackgroundTask]
    [-ForceUpdateFromAnyVersion]
    [-DisableAutoRepairs]
    [-CheckOnLaunch]
    [-ShowPrompt]
    [-UpdateBlocksActivation]
    [-UseSystemPolicySource]
    [-HoursBetweenUpdateChecks <UInt32>]
    [-Version <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

PauseAutoUpdateOptionsSet 

Set-AppxPackageAutoUpdateSettings
    [-PackageFamilyName] <String>
    -HoursToPause <UInt32>
    [-PauseUpdates]
    [-UseSystemPolicySource]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AppxPackageAutoUpdateSettings cmdlet provides access to configure a specific Windows App's Auto Update and Repair setings.

Examples

Example 1: Update the Auto Update settings for an App

$params = @{
    AppInstallerUri           =  'https://website.com/PackageName.appinstaller '
    PackageFamilyName         =  'PackageName_8h66172c634n0 '
    CheckOnLaunch             =  $true
    ForceUpdateFromAnyVersion =  $true
    HoursBetweenUpdateChecks  =  2
    ShowPrompt                =  $true
    UpdateUris                =  'file://ComputerName/Share/PackageName_x64.appinstaller'
}
Set-AppxPackageAutoUpdateSettings @params

This cmdlet will update the Auto Update settings of the PackageName_8h66172c634n0 Windows App to target an AppInstaller file on a network accessible file share every two hours, displaying a prompt to the user. Allowing for the Windows App to update to any version (higher or lower) despite the version of the installed Windows App.

Example 2: Disable the Auto Repair setting for an App

$params = @{
    AppInstallerUri    = 'https://website.com/PackageName.appinstaller'
    PackageFamilyName  = 'PackageName_8h66172c634n0'
    DisableAutoRepairs = $true
}
Set-AppxPackageAutoUpdateSettings @params

This cmdlet will disable the automatic repair of the Windows App.

Example 3: Pause Updates on a specific Windows App

$params = @{
    HoursToPause      = 4320
    PackageFamilyName = 'PackageName_8h66172c634n0'
    PauseUpdates      = $true
}
Set-AppxPackageAutoUpdateSettings @params

This cmdlet will pause the Windows App from checking for App updates for 4320 hours (180 Days).

Parameters

-AppInstallerUri

Specifies the location of the AppInstaller file targeted by this Windows App.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CheckOnLaunch

Specifies that the Windows App will check for new updates when the App is launched.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DependencyPackages

Specifies any Dependency Packages being used by the Windows App.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableAutoRepairs

Turns off the automatic repair of a broken Windows App.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableAutomaticBackgroundTask

Specifies that the automation of updating and repairing will occur as a background task.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceUpdateFromAnyVersion

Specifies that the next update of the Windows App can be of a higher or lower version.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HoursBetweenUpdateChecks

Specifies the time between update checks allowed for a specific Windows App.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HoursToPause

Specifies the duration of time in hours that the Windows App won't check for updates.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

PauseAutoUpdateOptionsSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OptionalPackages

Specifies the Optional Packages being used by the Windows App.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PackageFamilyName

Specifies the Package Family Name of the Windows App which is being modified.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PauseUpdates

Specifies if the Windows App updates are to be paused.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

PauseAutoUpdateOptionsSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RepairUris

Specifies the location which will be sourced from when repairing the Windows App.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ShowPrompt

Specifies that if any action is occurring for the Windows App, a prompt will be displayed.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UpdateBlocksActivation

Specifies that if an update is available for a Windows App, the App will prevent launching until the update has been installed.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UpdateUris

Specifies the location which will be sourced from when updating the Windows App.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UseSystemPolicySource

Specifies that an override can be applied to the Developer configured settings.

Parameter properties

Type:SwitchParameter
Default value:None
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

-Version

Specifies the version of the Update Settings being applied.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetAutoUpdateOptionsSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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.

Inputs

String

Outputs

Object