Configure web address settings
Using the PowerShell Get-CrmSetting
and Set-CrmSetting
cmdlets you can update the settings in your Dynamics 365 Customer Engagement (on-premises) deployment. One of the types of settings you can change is the web address settings.
Requirements
To set up the Dynamics 365 Customer Engagement (on-premises) PowerShell cmdlets, see Get started using the Dynamics 365 Customer Engagement Management (on-premises) PowerShell cmdlets.
Demonstrates
You can use the following script to update web address settings: partner-hosted (IFD). You must specify the following parameters:
RootDomainScheme: The root domain scheme: http or https.
DeploymentSdkRootDomain: The root domain for the deployment web service (SDK).
DiscoveryRootDomain: The root domain for the discovery web service.
NlbEnabled: A Boolean
that specifies whether network load balancing (NLB) is enabled.
SdkRootDomain: The root domain for the organization web service (SDK).
SslHeader: The secured sockets layer (SSL) header.
WebAppRootDomain: The root domain for the Web application.
Example
param
(
#optional params
[string]$RootDomainScheme,
[string]$DeploymentSdkRootDomain,
[string]$DiscoveryRootDomain,
[boolean]$NlbEnabled,
[string]$SdkRootDomain,
[string]$SslHeader,
[string]$WebAppRootDomain
)
$RemoveSnapInWhenDone = $False
if (-not (Get-PSSnapin -Name Microsoft.Crm.PowerShell -ErrorAction SilentlyContinue))
{
Add-PSSnapin Microsoft.Crm.PowerShell
$RemoveSnapInWhenDone = $True
}
$WebAddressSettings = Get-CrmSetting -SettingType WebAddressSettings
if($DeploymentSdkRootDomain) {$WebAddressSettings.DeploymentSdkRootDomain = $DeploymentSdkRootDomain}
if($DiscoveryRootDomain) {$WebAddressSettings.DiscoveryRootDomain = $DiscoveryRootDomain}
if($PSBoundParameters.ContainsKey('NlbEnabled')) {$WebAddressSettings.NlbEnabled = $NlbEnabled}
if($RootDomainScheme) {$WebAddressSettings.RootDomainScheme = $RootDomainScheme}
if($SdkRootDomain) {$WebAddressSettings.SdkRootDomain = $SdkRootDomain}
if($PSBoundParameters.ContainsKey('SslHeader')) {$WebAddressSettings.SslHeader = $SslHeader}
if($WebAppRootDomain) {$WebAddressSettings.WebAppRootDomain = $WebAppRootDomain}
Set-CrmSetting -Setting $WebAddressSettings
$WebAddressSettings
if($RemoveSnapInWhenDone)
{
Remove-PSSnapin Microsoft.Crm.PowerShell
}
See Also
Administer the deployment using Windows PowerShell
Get and set deployment configuration settings
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for