Set-NAVServerAppConfiguration

  • Reference
Module:
Microsoft.BusinessCentral.Management

Specifies a setting in an application-specific configuration file for a Business Central Server instance.

Syntax

Set-NAVServerAppConfiguration
   -ApplicationId <String>
   -KeyName <String>
   [-KeyValue <String>]
   [-ServerInstance] <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

You can use this cmdlet to set a key-value pair for one of the following settings in an application-specific configuration file: AppProtocolName, AppIdUri, and AzureActiveDirectoryClientApplicationId.

The application-specific configuration file must already exist on the Business Central Server installation. You use the New-NAVServerAppConfiguration cmdlet to create the configuration file. The settings that you add in the application-specific configuration file will be used by the server instance.

Examples

EXAMPLE 1

Set-NAVServerAppConfiguration -ServerInstance BC  -ApplicationId FIN -KeyName AppProtocolName
-KeyValue 'ms-financials'

Description

This example sets the AppProtocolName setting in the configuration file for the Dynamics 365 for Financials to ms-financials.

Parameters

-ApplicationId

Specifies the application-specific configuration file for the Business Central Server instance that you want to modify. The value corresponds to the ID of the application. You can determine the ApplicationId from the name of the application-specific configuration file. For example, if the file name is CustomSettings.FIN.config, then the ApplicationId is FIN.

For Business Central on-premises, the default application ID is NAV.

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

-Force

Forces the command to run without asking for user confirmation.

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

-KeyName

Specifies the name of the setting that you want to set in the configuration file. The following settings are available:

AppProtocolName - Specifies the protocol to use in URL links to the application, similar to the http protocol in web page links. For example, with Dynamics 365 for Financials, by setting the parameter to "ms-financials" means that "ms-financials:///?page=31" would open the items list page 31. This parameter is used by the GETURL function on the server-side to produce the links when called from the application.

Currently, the supported values are: ms-financials and ms-dynamicsnav.

AppIdUri - Specifies the APP ID URI that is assigned to the Business Central application in Microsoft Entra ID.

AzureActiveDirectoryClientApplicationId - Specifies the CLIENT ID that is assigned to the Business Central application in Microsoft Entra ID.

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

-KeyValue

Specifies the value for the configuration setting that is defined by the KeyName parameter.

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

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

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