Get-PrintixPartnerTenant
This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.
SYNOPSIS
Retrieves a partner-managed tenant.
SYNTAX
Get-PrintixPartnerTenant [[-PartnerId] <String>] [-TenantId] <String> [-EmbedBillingInfo]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Required application type: partner API credentials issued by Printix. Returns the tenant HAL resource, optionally including _embedded.billing_info.
EXAMPLES
EXAMPLE 1
Get-PrintixPartnerTenant -TenantId $tenantId -EmbedBillingInfo
PARAMETERS
-PartnerId
The partner ID, defaulting to the partner connection's ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TenantId
The managed tenant ID. Not taken from the Cloud Print connection.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EmbedBillingInfo
Request embed=billing-info to include billing information in the tenant response.
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
RELATED LINKS
https://printix.github.io/partner-api/#_interacting_with_a_single_tenant