Get-HaloLookup
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 lookup information from the Halo API.
SYNTAX
Multi (Default)
Get-HaloLookup [-Lookup <String>] [-LookupID <Int64>] [-ShowAll] [-ExcludeZero]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Single
Get-HaloLookup -ItemID <Int64> [-Lookup <String>] [-LookupID <Int64>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves lookup types from the Halo API - supports a variety of filtering parameters.
EXAMPLES
PARAMETERS
-ItemID
Lookup Item ID
Type: Int64
Parameter Sets: Single
Aliases:
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Lookup
Lookup Type
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LookupID
Lookup ID
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-ShowAll
Show all records
Type: SwitchParameter
Parameter Sets: Multi
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ExcludeZero
Exclude default lookup options with ID 0.
Type: SwitchParameter
Parameter Sets: Multi
Aliases: exclude_zero
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.