Edit

Share via

Set-CMWindowsAppxDeploymentType

Module:
ConfigurationManager Module

Sets a Windows app package deployment type.

Syntax

ByAppName (Default) 

Set-CMWindowsAppxDeploymentType
    -ApplicationName <String>
    -DeploymentTypeName <String>
    [-ContentFallback <Boolean>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-TriggerVpn <Boolean>]
    [-AddRequirement <Rule[]>]
    [-ContentLocation <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppValue 

Set-CMWindowsAppxDeploymentType
    -Application <IResultObject>
    -DeploymentTypeName <String>
    [-ContentFallback <Boolean>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-TriggerVpn <Boolean>]
    [-AddRequirement <Rule[]>]
    [-ContentLocation <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByAppId 

Set-CMWindowsAppxDeploymentType
    -ApplicationId <Int32>
    -DeploymentTypeName <String>
    [-ContentFallback <Boolean>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-TriggerVpn <Boolean>]
    [-AddRequirement <Rule[]>]
    [-ContentLocation <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByDTValue 

Set-CMWindowsAppxDeploymentType
    -InputObject <IResultObject>
    [-ContentFallback <Boolean>]
    [-SlowNetworkDeploymentMode <ContentHandlingMode>]
    [-TriggerVpn <Boolean>]
    [-AddRequirement <Rule[]>]
    [-ContentLocation <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveLanguage <String[]>]
    [-RemoveRequirement <Rule[]>]
    [-AddLanguage <String[]>]
    [-Comment <String>]
    [-Force]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMWindowsAppxDeploymentType cmdlet changes the settings for a Windows app package deployment type.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Modify an app package deployment type

PS XYZ:\> Set-CMWindowsAppxdeploymentType -ApplicationName "Application1" -DeploymentTypeName "DTS" -NewName "DTS_New" -AddLanguage "en-US","zh-CN" -Comment "Deployment Type updated"

This command changes the name of the Windows app package deployment type named DTS for the application named Application1 to DTS_New, adds English and Chinese as supported languages, and adds a description.

Example 2: Modify an app package deployment type by using the pipeline

PS XYZ:\> Get-CMDeploymentType -ApplicationName "Application1" -DeploymentTypeName "DTS" | Set-CMWindowsAppxDeploymentType -NewName "DTS_New" -AddLanguage "en-US","zh-CN" -Comment "Deployment Type updated"

This command gets the Windows app package deployment type object named DTS for the application named Application1 and uses the pipeline operator to pass the object to Set-CMWindowsAppxDeploymentType. Set-CMWindowsAppxDeploymentType changes the name of the deployment type to DTS_New, adds English and Chinese as supported languages, and adds a description.

Parameters

-AddLanguage

Adds an array of languages that this deployment type supports. Provide the languages in the "languagecode2-country" or "languagecode2" format, for example: en, en-US, ja-JP, zh-CN.

For more information, see CultureInfo.Name.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddLanguages, Languages, Language

Parameter sets

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

-AddRequirement

Adds an array of requirements for this deployment type.

Parameter properties

Type:

Rule[]

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

-Application

Specifies an application object that is associated with this deployment type. To obtain an application object, use the Get-CMApplication cmdlet.

Parameter properties

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

Parameter sets

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

-ApplicationId

Specifies the ID of the application that is associated with this deployment type.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CI_ID, CIId

Parameter sets

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

-ApplicationName

Specifies the name of the application that is associated with this deployment type.

Parameter properties

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

Parameter sets

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

-Comment

Specifies a description for this deployment type.

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-ContentFallback

Indicates that a client can use a fallback location provided by a management point. A fallback location point provides an alternate location for source content when the content for the deployment type is not available on any of the preferred distribution points.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EnableContentLocationFallback, AllowClientsToUseFallbackSourceLocationForContent

Parameter sets

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

-ContentLocation

Specifies the path of the content. The site system server requires permissions to read the content files.

Parameter properties

Type:String
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

-DeploymentTypeName

Specifies a display name for this deployment type.

Parameter properties

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

Parameter sets

ByAppName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppValue
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByAppId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

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

Parameter sets

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-InputObject

Specifies a deployment type object. To obtain a deployment type object, use the Get-CMDeploymentType cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DeploymentType

Parameter sets

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

-NewName

Specifies a new name for this deployment type.

Parameter properties

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

Parameter sets

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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-RemoveLanguage

Removes an array of existing languages from this deployment type. Provide the languages in the "languagecode2-country" or "languagecode2" format, for example: en, en-US, ja-JP, zh-CN.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveLanguages

Parameter sets

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

-RemoveRequirement

Removes the existing installation requirements from this deployment type.

Parameter properties

Type:

Rule[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveRequirements

Parameter sets

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

-SlowNetworkDeploymentMode

Specifies the installation behavior of the deployment type on a slow network. Valid values are:

  • DoNothing
  • Download
  • DownloadContentForStreaming

Parameter properties

Type:ContentHandlingMode
Default value:None
Accepted values:DoNothing, Download
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

-TriggerVpn

Indicates that a virtual private network (VPN) connection is used automatically.

Parameter properties

Type:Boolean
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object