Skip to main content

Get-PrintixSites

Generated Cmdlet Help

This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.

SYNOPSIS​

Lists Site resources.

SYNTAX​

Get-PrintixSites [[-TenantId] <String>] [[-Page] <Int32>] [[-PageSize] <Int32>] [-All] [-Raw]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Lists Site resources. Uses the documented Printix Cloud Print API. Required application type: Cloud Print API. Requires Printix Premium.

EXAMPLES​

EXAMPLE 1​

Get-PrintixSites -TenantId $tenantId

PARAMETERS​

-TenantId​

The tenant ID. Defaults to the tenant selected by Connect-Printix.

Type: String
Parameter Sets: (All)
Aliases:

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

-Page​

The zero-based page number.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageSize​

The number of resources per page.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-All​

Follow HAL next links and return all pages, starting at Page if specified.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Raw​

Return the complete HAL document, including links and metadata.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS​

OUTPUTS​

System.Object​

NOTES​

https://printix.github.io/#_query_sites