Skip to main content

New-PrintixGroup

Generated Cmdlet Help

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

SYNOPSIS​

Creates an externally identified group.

SYNTAX​

New-PrintixGroup [[-TenantId] <String>] [-Name] <String> [-ExternalId] <String> [[-IdentityProvider] <String>]
[[-Description] <String>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]

DESCRIPTION​

Creates an externally identified group. Uses the documented Printix Cloud Print API. Required application type: Cloud Print API.

EXAMPLES​

EXAMPLE 1​

New-PrintixGroup -TenantId $tenantId -Name $name -ExternalId $externalId

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

-Name​

The Name value sent to Printix.

Type: String
Parameter Sets: (All)
Aliases:

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

-ExternalId​

The ExternalId value sent to Printix.

Type: String
Parameter Sets: (All)
Aliases:

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

-IdentityProvider​

The IdentityProvider value sent to Printix.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description​

The Description value sent to Printix.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
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

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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/#_create_group