Get-HaloCategory
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 Category information from the Halo API.
SYNTAX
Multi (Default)
Get-HaloCategory [-TypeID <String>] [-ShowAll] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloCategory -CategoryID <Int64> [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Retrieves Category types from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-CategoryID
Category ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-TypeID
Type ID
Type: String
Parameter Sets: Multi
Aliases: type_id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ShowAll
Include Details
Type: SwitchParameter
Parameter Sets: Multi
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.