< Back

Get-PartnerCustomerUser

Sat Jan 18, 2020 6:30 pm

NAME Get-PartnerCustomerUser



SYNOPSIS

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





SYNTAX

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



Get-PartnerCustomerUser [-CustomerId] <String> -UserId <String> [<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.





PARAMETERS

-CustomerId <String>

The identifier for the customer.



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ReturnDeletedUsers [<SwitchParameter>]

Specifies whether to show deleted users.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-UserId <String>

The identifier for the user.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-UserPrincipalName <String>

Identifier for the customer.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

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







NOTES









-------------------------- 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.







RELATED LINKS

Online Version: https://docs.microsoft.com/powershell/m ... stomerUser