Skip to main content

Invoke-HaloRequest

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

Sends a request to the Halo API.

SYNTAX

Invoke-HaloRequest [[-WebRequestParams] <Hashtable>] [-RawResult] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

Wrapper function to send web requests to the Halo API.

EXAMPLES

PARAMETERS

-WebRequestParams

Hashtable containing the web request parameters.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-RawResult

Returns the Raw result. Useful for file downloads.

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.

INPUTS

OUTPUTS

Outputs an object containing the response from the web request.

NOTES