Set-CrmAdvancedSetting

Module:

Microsoft.Crm.PowerShell

Sets the specified advanced setting value for a Dynamics 365 deployment.

Syntax

Set-CrmAdvancedSetting
   [[-ID] <String>]
   [-ConfigurationEntityName] <String>
   [-Setting] <String>
   [-Value] <String>
   [-Timeout <Int32>]
   [-Diag]
   [-Credential <PSCredential>]
   [-DwsServerUrl <String>]
   [-WhatIf]
   [-Confirm]

Set-CrmAdvancedSetting
   [-Entity] <ConfigurationEntity>
   [-Timeout <Int32>]
   [-Diag]
   [-Credential <PSCredential>]
   [-DwsServerUrl <String>]
   [-WhatIf]
   [-Confirm]

Description

The Set-CrmAdvancedSetting cmdlet is an advanced user command that should be used only when directed to do so by Microsoft Support or Microsoft documentation. It is not intended for general use.

Examples

Example 1

PS C:\>

There are no examples available for this cmdlet.

Parameters

-ConfigurationEntityName

Specifies the name of the configuration entity that settings will be read or set to.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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

-Entity

Specifies a constructed configuration object created from Microsoft.Xrm.Sdk.Deployment.Proxy.ConfigurationEntity.

Type:	ConfigurationEntity
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ID

Specifies the ID of the setting that should be set or returned.

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

-Setting

Specifies the name of the setting to get or set in the configuration entity.

Type:	String
Position:	2
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

-Value

Specifies the value to set in the configuration entity. For internal use only.

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

-WhatIf

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

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

Inputs

Microsoft.Xrm.Sdk.Deployment.ConfigurationEntity

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

Outputs

System.Object

Related Links

• Overview of Dynamics 365 Customer Engagement PowerShell