Get-PartnerCustomerUser
Gets a list of all customer users or a specified user for the tenant.
Syntax
ByCustomerId (Default)
Get-PartnerCustomerUser
[-CustomerId] <String>
[<CommonParameters>]
ByUserId
Get-PartnerCustomerUser
[-CustomerId] <String>
-UserId <String>
[<CommonParameters>]
ByUserState
Get-PartnerCustomerUser
[-CustomerId] <String>
[-ReturnDeletedUsers]
[<CommonParameters>]
ByUpn
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 00aa00aa-bb11-cc22-dd33-44ee44ee44ee
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReturnDeletedUsers
Specifies whether to show deleted users.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByUserState
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserId
The identifier for the user.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByUserId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserPrincipalName
Identifier for the customer.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByUpn
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.