Set-CrmAdvancedSetting

Applies To: CRM 2015 on-prem

Set-CrmAdvancedSetting

Sets an advanced setting value for Microsoft Dynamics CRM.

Syntax

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

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




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

Parameters

-ConfigurationEntityName<String>

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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-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

-Entity<ConfigurationEntity>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ID<String>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Setting<String>

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


Aliases

none

Required?

true

Position?

3

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

-Value<String>

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


Aliases

none

Required?

true

Position?

4

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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (http://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

 

 

Show: