Share via


Get-NAVServerAppConfiguration

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

Syntax

Default (Default)

Get-NAVServerAppConfiguration
    -ApplicationId <String>
    [-ServerInstance] <String>
    [-Force]
    [<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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

System.Xml.XmlNode

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