Set-CrmSetting

Applies To: CRM 2016 on-prem, Dynamics 365 (on-premises)

Set-CrmSetting

Sets the specified Microsoft Dynamics 365 deployment-wide settings.

Syntax

Parameter Set: Default
Set-CrmSetting [-Setting] <DeploymentObject> [-Credential <PSCredential> ] [-Diag] [-DwsServerUrl <String> ] [-Timeout <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-CrmSetting cmdlet sets the specified Microsoft Dynamics 365 deployment settings. The object is different based on the type of setting requested. These settings are used in this cmdlet to update configurations in a Microsoft Dynamics 365 deployment.

For the most current list of supported classes, see Update deployment configuration settings in the Operating guide for Microsoft Dynamics 365.

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 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.

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

-Setting<DeploymentObject>

Specifies a DeploymentConfigSettings object containing the settings to update. The specified object must be one of the following types: 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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 monitoring setting data to update, sets the UpdateCertificateLifetimeNotificationThreshold to 20, and executes the update.

PS C:\> $MonitoringData = Get-CrmSetting –SettingType MonitoringSettings $MonitoringData.CertificateLifetimeNotificationThreshold = 20 Set-CrmSetting –Setting $MonitoringData

PS C:\>