Get-CrmAdvancedSetting
Returns an advanced setting value for the Dynamics 365 deployment.
Syntax
Get-CrmAdvancedSetting
-ConfigurationEntityName <String>
-Setting <String>
[-Id <Guid>]
[-Timeout <Int32>]
[-Diag]
[-Credential <PSCredential>]
[-DwsServerUrl <String>]
Description
The Get-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. When used, it returns an advanced setting value for the Dynamics 365 deployment.
Examples
Example 1
PS C:\>
Parameters
-ConfigurationEntityName
Specifies the name of the configuration entity that settings will be read to or set to.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
-Id
Specifies the ID of the setting that should be returned.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Setting
Specifies the name of the advanced setting to retrieve from the configuration entity.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
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.ConfigurationEntity