Get-NAVTableConnection

Gets a list of connections to external database tables from a Business Central application.

Syntax

Get-NAVTableConnection
   [-ServerInstance] <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-NAVTableConnection
   [-ServerInstance] <String>
   -ConnectionType <TableConnectionType>
   -ConnectionId <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-NAVTableConnection
   [-ApplicationDatabaseServer <String>]
   -ApplicationDatabaseName <String>
   [-ApplicationDatabaseCredentials <PSCredential>]
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-NAVTableConnection
   [-ApplicationDatabaseServer <String>]
   -ApplicationDatabaseName <String>
   [-ApplicationDatabaseCredentials <PSCredential>]
   -ConnectionType <TableConnectionType>
   -ConnectionId <String>
   [-Force]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Use the Get-NAVTableConnection cmdlet to get a list of table connections from the specified Business Central application.

Examples

EXAMPLE 1

Get-NAVTableConnection -ServerInstance BC

This example returns a list of all connections to external database tables.

Parameters

-ApplicationDatabaseCredentials

Specifies the user name and password of the login account that the Business Central Server instance uses to access the application database in SQL Server when using SQL Server Authentication.

This parameter is only relevant when you set with the ApplicationDatabaseServer and ApplicationDatabaseName parameters

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

-ApplicationDatabaseName

Specifies the name of the Business Central database that contains the application tables in a multitenant deployment.

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

-ApplicationDatabaseServer

Specifies the name of the computer on which the SQL Server instance for the Business Central database that contains the application tables is installed in the multitenant deployment.

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

-ConnectionId

Specifies the name of the table connection.

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

-ConnectionType

Specifies the type of table connection. In the current version of Business Central, you can specify two types of connection: CRM or ExternalSQL.

Type:TableConnectionType
Accepted values:ExternalSQL, CRM
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