Set-AppVentiXPublishingTask¶
SYNOPSIS¶
Updates the properties of an AppVentiX publishing task.
SYNTAX¶
__AllParameterSets¶
Set-AppVentiXPublishingTask [-Id] <string> [[-MachineGroupFriendlyname] <string[]>]
[[-ADGroup] <string[]>] [[-EntraIDGroup] <string[]>] [[-Priority] <int>] [[-ConfigShare] <string>]
[<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases,
DESCRIPTION¶
The Set-AppVentiXPublishingTask function is used to update the properties of an existing AppVentiX publishing task. It allows you to modify the MachineGroupFriendlyname, AD groups, Entra ID groups, and Priority of the task.
Every run also brings the task up to date with the RelativePath element, which holds the package path relative to the Content Share. Piping Get-AppVentiXPublishingTask into this function without any other parameter therefore adds the missing relative paths.
Tasks can be piped in, and the Publishing Tasks file is read once and saved once for the whole pipeline.
EXAMPLES¶
EXAMPLE 1¶
Set-AppVentiXPublishingTask -Id "12345678-1234-1234-1234-1234567890AB" -MachineGroupFriendlyname "MyMachineGroup" -Group "DOMAIN\GROUP" -Priority 1 -ConfigShare "\fileserver.domain.local\config"
This example updates the properties of the publishing task with the specified ID. It changes the machine group friendly name to "MyMachineGroup", the group name to "DOMAIN\GROUP", the priority to 1, and uses the specified configuration share path.
EXAMPLE 2¶
Get-AppVentiXPublishingTask | Set-AppVentiXPublishingTask
This example adds the missing relative path to every user publishing task, without changing anything else.
EXAMPLE 3¶
Set-AppVentiXPublishingTask -Id "12345678-1234-1234-1234-1234567890AB"
This example adds the missing relative path to the publishing task with the specified ID.
EXAMPLE 4¶
Set-AppVentiXPublishingTask -Id "12345678-1234-1234-1234-1234567890AB" -ADGroup "DOMAIN.LOCAL\GROUP" -EntraIDGroup "AppVentiX - Apps"
This example replaces the groups of the publishing task with an AD group and an Entra ID group.
PARAMETERS¶
-ADGroup¶
Specifies the AD group names associated with the publishing task. The group name should contain the domain name and the group name, e.g., "DOMAIN.LOCAL\GROUP". When -ADGroup or -EntraIDGroup is provided, all groups of the task are replaced. If neither is provided, the groups will not be changed. Alias: Group
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Group
ParameterSets:
- Name: (All)
Position: 2
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-ConfigShare¶
Specifies the configuration share path. If this parameter is not provided, the default configuration share path will be used.
Type: System.String
DefaultValue: $Script:AppVentix.ConfigShare
SupportsWildcards: false
Aliases:
- Config
- Share
- AppVentixConfigShare
ParameterSets:
- Name: (All)
Position: 5
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-EntraIDGroup¶
Specifies the display names or object IDs of the Entra ID groups associated with the publishing task, e.g. "AppVentiX - Apps". Can be combined with -ADGroup. Requires Entra ID integration to be enabled in AppVentiX. The groups are looked up in Microsoft Graph, which asks for a device-code sign-in when no cached sign-in is available. Use Connect-AppVentiXAzure to sign in beforehand.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 3
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Id¶
Specifies the ID of the publishing task to be updated. The ID must be a valid GUID. Accepts the Id of the objects returned by Get-AppVentiXPublishingTask from the pipeline.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 0
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-MachineGroupFriendlyname¶
Specifies the friendly name of the machine group associated with the publishing task. If this parameter is not provided, the machine group friendly name will not be changed.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 1
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Priority¶
Specifies the priority of the publishing task. If this parameter is not provided, the priority will not be changed.
Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: 4
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.