Modifies one or all Included Items under an AppSetting. Only specified properties are changed.
Syntax
Set-LiquitAppSettingIncludedItem [-Parent] <AppSetting> [-IncludedItemIndex <int>] [-Name <string>] [-Enabled <bool>] [-ValueType <IncludedItemValueType>] [-Root <string>] [-Value <string>] [-CleanBeforeRestore <bool>] [-WhatIf] [-Confirm]
Parameters
| Parameter | Type | Position | Mandatory | Description |
|---|---|---|---|---|
Parent |
AppSetting |
0 | Yes | The parent AppSetting whose Included Items to modify. Accepts pipeline input. |
IncludedItemIndex |
int |
— | No | Zero-based index of the specific Included Item to patch. If omitted, all Included Items under the parent are updated. Must be ≥ 0. |
Name |
string |
— | No | New display name. |
Enabled |
bool |
— | No | New enabled state. |
ValueType |
IncludedItemValueType |
— | No | New value type. |
Root |
string |
— | No | New root path. Trailing \ is stripped automatically. |
Value |
string |
— | No | New relative path/name. Leading \ is stripped automatically. |
CleanBeforeRestore |
bool |
— | No | New clean-before-restore flag. |
If
IncludedItemIndexis out of range, a non-terminating error is written and no changes are made.If no modifiable parameter is provided, the cmdlet does nothing and returns no output.
Output: AppSettingIncludedItem
Supports: -WhatIf, -Confirm
Examples
# Disable the first included item $setting = Get-LiquitAppSetting -Name 'Outlook Settings' Set-LiquitAppSettingIncludedItem -Parent $setting -IncludedItemIndex 0 -Enabled $false # Update the Root path for all included items Set-LiquitAppSettingIncludedItem -Parent $setting -Root 'D:\Profiles\%USERNAME%'