Share via


Get-NAVTableConnection

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

Syntax

UseNST (Default)

Get-NAVTableConnection
    [-ServerInstance] <String>
    [-Force]
    [<CommonParameters>]

UseNSTSpecificConnection

Get-NAVTableConnection
    [-ServerInstance] <String>
    -ConnectionType <TableConnectionType>
    -ConnectionId <String>
    [-Force]
    [<CommonParameters>]

UseDatabase

Get-NAVTableConnection
    -ApplicationDatabaseName <String>
    [-ApplicationDatabaseServer <String>]
    [-ApplicationDatabaseCredentials <PSCredential>]
    [-Force]
    [<CommonParameters>]

UseDatabaseSpecificConnection

Get-NAVTableConnection
    -ApplicationDatabaseName <String>
    -ConnectionType <TableConnectionType>
    -ConnectionId <String>
    [-ApplicationDatabaseServer <String>]
    [-ApplicationDatabaseCredentials <PSCredential>]
    [-Force]
    [<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

Parameter properties

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

Parameter sets

UseDatabase
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
UseDatabaseSpecificConnection
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ApplicationDatabaseName

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

Parameter properties

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

Parameter sets

UseDatabase
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
UseDatabaseSpecificConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

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

Parameter sets

UseDatabase
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
UseDatabaseSpecificConnection
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ConnectionId

Specifies the name of the table connection.

Parameter properties

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

Parameter sets

UseNSTSpecificConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
UseDatabaseSpecificConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:TableConnectionType
Default value:None
Accepted values:CRM, ExternalSQL, Exchange, MicrosoftGraph, Query
Supports wildcards:False
DontShow:False

Parameter sets

UseNSTSpecificConnection
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
UseDatabaseSpecificConnection
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

UseNST
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
UseNSTSpecificConnection
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.