Skip to main content

Get-HaloViewListGroup

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 view list group profiles from the Halo API.

SYNTAX​

Multi (Default)​

Get-HaloViewListGroup [-Type <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single​

Get-HaloViewListGroup -ViewListGroupId <Int64> [-IncludeDetails] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION​

Retrieves view list group from the Halo API - supports a variety of list grouping parameters.

EXAMPLES​

PARAMETERS​

-ViewListGroupId​

View List Group 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 following view list group type.

Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDetails​

Include detailed information about the view list group.

Type: SwitchParameter
Parameter Sets: Single
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.

INPUTS​

OUTPUTS​

A powershell object containing the response.​

NOTES​