| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Get user from the connected organization.
Get-CrmUser [[-Name] <String>] [-Exclude <String>] [-BusinessUnit <Guid>] [-IncludeDisabled]
[-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get-CrmUser [-Id] <Guid[]> [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
Get user from the connected organization.
PS C:\> Get-CrmUser -UserName 'user1@organization.com'
Gets the user matching username 'user1@organization.com'.
The id of a business unit to retrieve the related users for.
Type: System.Guid
Parameter Sets: GetAllUsers
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseExclude users whose name matches the provided pattern.
Type: System.String
Parameter Sets: GetAllUsers
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueThe id of the user to retrieve.
Type: System.Guid[]
Parameter Sets: GetUserById
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseInclude inactive users in the result.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: GetAllUsers
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseInclude users whose name matches the provided pattern.
Type: System.String
Parameter Sets: GetAllUsers
Aliases: Include
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueReturn the total count (and accuracy) of the number of records before returning the result.
Because of the limitations of Dynamics CRM, the total count is only returned accurate when the result is limited to 5000 items
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSkips (does not return) the specified number of records.
Type: System.UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the number of records to retrieve from the beginning.
Type: System.UInt64
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.