Skip to content

Disable-AppVentiXUserSetting

SYNOPSIS

Disables one or more AppVentiX User Settings.

SYNTAX

__AllParameterSets

Disable-AppVentiXUserSetting [-Id] <guid[]> [[-ConfigShare] <string>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Disable-AppVentiXUserSetting sets the Enabled element of a User Setting to False. A disabled User Setting is not processed, but keeps its configuration and assignments. User Settings created with an older version of AppVentiX Central View have no Enabled element and are treated as enabled. The element is added when the User Setting is disabled. A User Setting that is already disabled is not changed.

EXAMPLES

EXAMPLE 1

Disable-AppVentiXUserSetting -Id '37db88b4-f9f1-47bb-b913-f0538d94158c'

Disables one User Setting.

EXAMPLE 2

Get-AppVentiXUserSettings -FriendlyName 'VS Code*' | Disable-AppVentiXUserSetting -WhatIf

Shows which User Settings whose name starts with "VS Code" would be disabled.

PARAMETERS

-ConfigShare

Specifies the path to the AppVentiX configuration share. You can omit this parameter if the configuration store was already set with Set-AppVentiXConfigShare, or when it can be detected automatically (for example on a machine where AppVentiX Central View is installed and configured).

Type: System.String
DefaultValue: $Script:AppVentiX.ConfigShare
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

One or more User Setting Ids (GUID). Accepts the Id property from the pipeline, e.g. from Get-AppVentiXUserSettings.

Type: System.Guid[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  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.

INPUTS

System.Guid[]

OUTPUTS