Invoke-PrintixRequest
This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.
SYNOPSIS
Sends an authenticated request to the Printix Cloud Print API.
SYNTAX
Invoke-PrintixRequest [-Resource] <String> [[-Method] <String>] [[-Query] <Hashtable>] [[-Body] <Object>]
[[-Headers] <Hashtable>] [[-ResponseProperty] <String>] [-All] [-Raw] [[-MaxRetryCount] <Int32>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Serializes JSON, renews tokens, follows HAL next links when requested and retries HTTP 429 only. The required application type depends on the endpoint. Types are mutually exclusive, not scopes. Partner API requests use Invoke-PrintixPartnerRequest and a separate partner connection.
EXAMPLES
EXAMPLE 1
Invoke-PrintixRequest -Resource 'tenants/tenant-id/users' -Query @{ role = 'USER' } -ResponseProperty users -All
PARAMETERS
-Resource
An API resource relative to cloudprint, or an absolute Cloud Print API HAL link.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Method
The HTTP method, defaulting to GET.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: GET
Accept pipeline input: False
Accept wildcard characters: False
-Query
Query fields. Arrays become comma-separated values; false and zero are preserved.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: @{}
Accept pipeline input: False
Accept wildcard characters: False
-Body
An object to serialize as JSON, or JSON text.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Headers
Additional headers. Authorization cannot be overridden.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: @{}
Accept pipeline input: False
Accept wildcard characters: False
-ResponseProperty
The response property to emit. Omit to return the complete document.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-All
Follow HAL next links for GET requests.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return complete response documents instead of extracting ResponseProperty.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-MaxRetryCount
Maximum retries after HTTP 429, defaulting to five.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
Controls progress-record handling. Available in PowerShell 7.4 and later.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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.