Get-PartnerCustomerUser

Reference

Module:: PartnerCenter

Gets a list of all customer users or a specified user for the tenant.

Syntax

Get-PartnerCustomerUser
   [-CustomerId] <String>
   [<CommonParameters>]

Get-PartnerCustomerUser
   [-CustomerId] <String>
   -UserId <String>
   [<CommonParameters>]

Get-PartnerCustomerUser
   [-CustomerId] <String>
   [-ReturnDeletedUsers]
   [<CommonParameters>]

Get-PartnerCustomerUser
   [-CustomerId] <String>
   -UserPrincipalName <String>
   [<CommonParameters>]

Description

The Get-PartnerCustomerUser cmdlet returns either a list of customer users based on the specified customer identifier, or it returns a specific user based on the specified user identifier or user principal name.

Examples

Example 1

PS C:\> Get-PartnerCustomerUser -CustomerId 45916f92-e9c3-4ed2-b8c2-d87aa129905f

Gets a list of all active users for the specified customer identifier.

Example 2

PS C:\> Get-PartnerCustomerUser -CustomerId 45916f92-e9c3-4ed2-b8c2-d87aa129905f -UserId e2e56b09-aac5-4685-947d-29e735ee7ed7

Gets information for the specified user.

Example 3

PS C:\> Get-PartnerCustomerUser -CustomerId 45916f92-e9c3-4ed2-b8c2-d87aa129905f -ReturnDeletedUsers

Gets a list of all deleted users for the specific customer.

Parameters

-CustomerId

The identifier for the customer.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ReturnDeletedUsers

Specifies whether to show deleted users.

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

-UserId

The identifier for the user.

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

-UserPrincipalName

Identifier for the customer.

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

Inputs

None

Outputs

Microsoft.Store.PartnerCenter.PowerShell.Models.Users.PSCustomerUser