New-UssParameter
SYNOPSIS
Creates a new parameter.
SYNTAX
New-UssParameter [-Description] <String> [-Key] <String> [[-DefaultValue] <String>] [[-Widget] <WidgetEnum>]
[-Required] [-Hidden] [-Hint <String>] [-Labels <String[]>] [-Values <String[]>] [<CommonParameters>]
DESCRIPTION
Use New-UssParameter to create a new parameter object to use with a manifest.
PARAMETERS
-DefaultValue
Specifies the default value of the parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
Specifies the description of the parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hidden
Specifies that the parameter is hidden from the user interface.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hint
Specifies the hint of the parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Key
Specifies the key of the parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Labels
Specifies the labels of the parameter.
Only applicable for widget DropDown.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Required
Specifies that the parameter is required.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Values
Specifies the available values of the parameter.
Only applicable for widget DropDown.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Widget
Specifies the widget type of the parameter.
| Widget Type | Description |
|---|---|
| TextBox | Plain text box that accepts strings. |
| Numeric | Numeric box that accepts negative or positive integers. |
| CheckBox | A boolean check box. |
| OpenFile | Text box and a browse button to select a file from file system. |
| SaveFile | Text box and a browse button to select a location to save a file. |
| Password | A password text box. |
| OpenFolder | A text box and a browse button to select a directory. |
| Database | A field to select a database instance, database and to provide a user and password. |
| OpenDatabase | A field to select a database instance, database and to provide a user and password. Database must exists. |
| NewDatabase | A field to select a database instance, database and to provide a user and password. Database must not exists. |
Type: WidgetEnum
Parameter Sets: (All)
Aliases:
Accepted values: TextBox, Password, Numeric, CheckBox, Database, OpenFile, SaveFile, OpenFolder, OpenDatabase, NewDatabase, DropDown
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.