< Back
Get-CrmUserSettings
Post
NAME Get-CrmUserSettings
SYNOPSIS
Retrieves CRM user's settings.
SYNTAX
Get-CrmUserSettings [-conn <CrmServiceClient>] [-UserId] <String> [-Fields] <String[]> [<CommonParameters>]
DESCRIPTION
The Get-CrmUserSettings cmdlet lets you retrieve CRM user's settings.
PARAMETERS
-conn <CrmServiceClient>
A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserId <String>
An Id (guid) of CRM User.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Fields <String[]>
A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to
retrieve all fields (not recommended for performance reason.)
Required? true
Position? 2
Default value
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
OUTPUTS
NOTES
-------------------------- Example 1 --------------------------
Get-CrmUserSettings -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -Fields *
This example retrieves all fields from specified User's UserSettings.
timeformatcode_Property : [timeformatcode, 0]
timeformatcode : 0
timezonestandardminute_Property : [timezonestandardminute, 0]
timezonestandardminute : 0
synccontactcompany_Property : [synccontactcompany, True]
synccontactcompany : Yes
...
-------------------------- Example 2 --------------------------
Get-CrmUserSettings (Get-MyCrmUserId) *
This example retrieves all fields from login User's UserSettings by omitting parameter names.
When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.
timeformatcode_Property : [timeformatcode, 0]
timeformatcode : 0
timezonestandardminute_Property : [timezonestandardminute, 0]
timezonestandardminute : 0
synccontactcompany_Property : [synccontactcompany, True]
synccontactcompany : Yes
...
RELATED LINKS
SYNOPSIS
Retrieves CRM user's settings.
SYNTAX
Get-CrmUserSettings [-conn <CrmServiceClient>] [-UserId] <String> [-Fields] <String[]> [<CommonParameters>]
DESCRIPTION
The Get-CrmUserSettings cmdlet lets you retrieve CRM user's settings.
PARAMETERS
-conn <CrmServiceClient>
A connection to your CRM organization. Use $conn = Get-CrmConnection <Parameters> to generate it.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UserId <String>
An Id (guid) of CRM User.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Fields <String[]>
A List of field logicalnames. Use "fieldname1, fieldname2, fieldname3" syntax to specify Fields, or use "*" to
retrieve all fields (not recommended for performance reason.)
Required? true
Position? 2
Default value
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
OUTPUTS
NOTES
-------------------------- Example 1 --------------------------
Get-CrmUserSettings -conn $conn -UserId f9d40920-7a43-4f51-9749-0549c4caf67d -Fields *
This example retrieves all fields from specified User's UserSettings.
timeformatcode_Property : [timeformatcode, 0]
timeformatcode : 0
timezonestandardminute_Property : [timezonestandardminute, 0]
timezonestandardminute : 0
synccontactcompany_Property : [synccontactcompany, True]
synccontactcompany : Yes
...
-------------------------- Example 2 --------------------------
Get-CrmUserSettings (Get-MyCrmUserId) *
This example retrieves all fields from login User's UserSettings by omitting parameter names.
When omitting parameter names, you do not provide $conn, cmdlets automatically finds it.
timeformatcode_Property : [timeformatcode, 0]
timeformatcode : 0
timezonestandardminute_Property : [timezonestandardminute, 0]
timezonestandardminute : 0
synccontactcompany_Property : [synccontactcompany, True]
synccontactcompany : Yes
...
RELATED LINKS