Get-CrmSetting

Applies To: CRM 2015 on-prem

Get-CrmSetting

Retrieves a Microsoft Dynamics CRM deployment setting object.

Syntax

Parameter Set: Default
Get-CrmSetting [-SettingType] <String> {AsyncSettings | ClaimsSettings | OAuthClaimsSettings | DashboardSettings | DupSettings | IfdSettings | ImportSettings | MonitoringSettings | TraceSettings | WebAddressSettings | WorkflowSettings | ServerSideSyncEmailSettings | ServerSideSyncQueueSettings | ServerSideSyncACTSettings | SqmSettings | MarketplaceSettings | EtmSettings | ThrottleSettings | CustomCodeSettings | YammerSettings | TeamSettings | MultiEntityQuickFindSettings | QuickFindSettings} [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-CrmSetting cmdlet retrieves a Microsoft Dynamics CRM deployment setting object. The object returned is different based on the type of setting requested. These settings are used in the cmdlet to update configurations in a Microsoft Dynamics CRM deployment.

For the current list of supported classes, see Get and set deployment configuration settings in the Operating guide for Microsoft Dynamics CRM.

Parameters

-Credential<PSCredential>

Specifies the credentials used to log in to the Deployment web service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-Diag

Turns on stack traces for error reports returned from Microsoft Dynamics CRM service calls. Enabling this emits a detailed error message, including a stack trace, when an error is encountered by the CRM PowerShell command.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-DwsServerUrl<String>

Identifies the location of the Deployment web service. This should be in the format: http://<serverurl> or https://<serverurl>, for example, http://contoso.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SettingType<String>

Indicates the type of deployment setting object to retrieve. Currently, possible values are: AsyncSettings, ClaimsSettings, DashboardSettings, DupSettings, IfdSettings, ImportSettings, TraceSettings, WebAddressSettings, WorkflowSettings, SqmSettings, MarketplaceSettings, EtmSettings, TeamSettings,ThrottleSettings, CustomCodeSettings, MonitoringSettings, MultiEntityQuickFindSettings, QuickFindSettings, OAuthClaimsSettings, and YammerSettings.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-Timeout<Int32>

For internal use only.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------------------- EXAMPLE 1 --------------------------

This example returns the asynchronous settings of the deployment.

PS C:\> Get-CrmSetting –SettingType AsyncSettings

-------------------------- EXAMPLE 2 --------------------------

This example returns the Internet-facing deployment (IFD) settings of the deployment.

PS C:\> Get-CrmSetting –SettingType IfdSettings