Share via

Get-CrmSetting

  • Reference
Module:
Microsoft.Crm.PowerShell

Retrieves a Dynamics 365 deployment setting object.

Syntax

Get-CrmSetting
   [-SettingType] <String>
   [-Timeout <Int32>]
   [-Diag]
   [-Credential <PSCredential>]
   [-DwsServerUrl <String>]

Description

The Get-CrmSetting cmdlet retrieves a Dynamics 365 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 Dynamics 365 deployment.

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

Examples

Example 1

PS C:\> Get-CrmSetting -SettingType AsyncSettings

Returns the asynchronous processing settings of the deployment.

Example 2

PS C:\> Get-CrmSetting -SettingType IfdSettings

Returns the Internet-facing deployment (IFD) settings of the deployment.

Parameters

-Credential

Expects a variable that contains the user credentials used for signing in to Dynamics 365 on-premises organization. To establish this variable, run the PowerShell command $Cred = Get-Credential.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Diag

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DwsServerUrl

The URL of the Deployment Web Service. This should be in the format: https://, for example, https://contoso.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SettingType

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

Type:String
Accepted values:AsyncSettings, ClaimsSettings, OAuthClaimsSettings, DashboardSettings, DupSettings, IfdSettings, ImportSettings, MonitoringSettings, TraceSettings, WebAddressSettings, WorkflowSettings, ServerSideSyncEmailSettings, ServerSideSyncQueueSettings, ServerSideSyncACTSettings, SqmSettings, MarketplaceSettings, EtmSettings, ThrottleSettings, CustomCodeSettings, YammerSettings, TeamSettings, MultiEntityQuickFindSettings, QuickFindSettings, ServerSideSyncEmailSettings, ServerSideSyncQueueSettings, ServerSideSyncACTSettings, MarketplaceSettings
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

For internal use only.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.String

System.Int32 System.Management.Automation.SwitchParameter System.Management.Automation.PSCredential

Outputs

Microsoft.Xrm.Sdk.Deployment.DeploymentConfigSettings