Get-HaloCustomButton
Generated Cmdlet Help
This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Gets custom buttons from the Halo API.
SYNTAX
Multi (Default)
Get-HaloCustomButton [-Type <String>] [-TypeID <Int64>] [-IsButtonSetup] [-IncludeDetails]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloCustomButton -CustomButtonID <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves custom buttons from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-CustomButtonID
Custom Button ID.
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Type
Filter by the specified type.
Type: String
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TypeID
Filter by the specified type ID.
Type: Int64
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-IsButtonSetup
Include custom buttons which are setup (defaults to $True).
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IncludeDetails
Include extra detail objects in the response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.