Share via

Get-NAVServerAppConfiguration

  • Reference
Module:
Microsoft.BusinessCentral.Management

Returns the settings in an application-specific configuration file of a Business Central Server instance.

Syntax

Get-NAVServerAppConfiguration
   -ApplicationId <String>
   [-ServerInstance] <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

The Get-NAVServerAppConfiguration cmdlet retrieves the settings in the application-specific configuration file. You create an application-specific configuration file by using the New-NAVServerApplicationConfiguration cmdlet.

Examples

EXAMPLE 1

Get-NAVServerAppConfiguration -ServerInstance BC  -ApplicationId FIN

This example returns the settings in the application-specific configuration file for the FIN application.

Parameters

-ApplicationId

Specifies the application-specific configuration file for the Business Central Server instance that you want to view. The value corresponds to the ID of the application. You can determine the ApplicationId from the name 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

-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

-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

Outputs

System.Xml.XmlNode

An XML document containing key value pairs of the application specific server configuration.