Share via

Get-NAVAppInfo

Module:
Microsoft.Dynamics.Nav.Apps.Management Module

Gets information about a Business Central app based on the specified package file or the specified Business Central Server instance.

Syntax

Properties (Default) 

Get-NAVAppInfo
    [-ServerInstance] <String>
    [-Id <Guid>]
    [-Name <String>]
    [-Publisher <String>]
    [-Version <Version>]
    [-SymbolsOnly]
    [<CommonParameters>]

TenantSpecificProperties 

Get-NAVAppInfo
    [-ServerInstance] <String>
    -Tenant <TenantId>
    [-Id <Guid>]
    [-Name <String>]
    [-Publisher <String>]
    [-Version <Version>]
    [-TenantSpecificProperties]
    [<CommonParameters>]

Tenant 

Get-NAVAppInfo
    [-ServerInstance] <String>
    -Tenant <TenantId>
    [<CommonParameters>]

PathWithServerInstance 

Get-NAVAppInfo
    [-ServerInstance] <String>
    -Tenant <TenantId>
    -Path <String>
    [<CommonParameters>]

Path 

Get-NAVAppInfo
    -Path <String>
    [<CommonParameters>]

Description

Use the Get-NAVAppInfo cmdlet to get information about a specific Business Central app, or to get a list of Business Central apps that have been deployed. The list of deployed Business Central apps can include all Business Central apps that have been published to a Business Central Server instance, filtered by Business Central app properties, or Business Central apps that are published for a specific tenant.

  • If you know to the location of App package (.app file), you get information about it by providing the path to the file.

  • To get information about all Apps published to the application on a server instance, specify the server instance. If you want to filter the list to specific Apps, then use other parameters, like ID, publisher, and version.

  • To get information about all apps that are installed on a specific tenant, specify the server instance and the tenant. With a single tenant server instance, the tenant is named `default'. If you want to filter the list to specific Apps, then use other parameters, like Id, publisher, and version.

  • To get information about all apps that are installed and published on a specific tenant, specify the server instance, the tenant, and the TenantSpecificproperties.

  • To get information about symbols published to the application on a server instance, specify the server instance and the -SymbolsOnly switch.

Note: To get a list of all tenants on which a specific App is installed, you can use the Get-NAVAppTenant cmdlet.

Examples

EXAMPLE 1

Get-NAVAppInfo -ServerInstance DynamicsNAV90

                    Id                                       Name                 Version    Publisher
                    --                                       ----                 -------    ---------
                    9a47a833-e22f-4812-ade314219c53          SmartApp Base        2.0.0.300  Proseware, Inc.
                    3c88160c-e0eb-4fe1-b4f6-011e45d74b10     Proseware SmartApp   2.3.4.500  Proseware, Inc.

This example returns information about all of the Business Central apps published on the DynamicsNAV90 server instance.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Name 'Proseware SmartApp' -Version 2.3.4.500

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/EULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about the Business Central app with the specified name and version on the DynamicsNAV90 server instance.

EXAMPLE 3

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Publisher 'Proseware, Inc.'

                    Id                                       Name                 Version    Publisher
                    --                                       ----                 -------    ---------
                    9a47a833-e22f-4812-ade314219c53          SmartApp Base        2.0.0.300  Proseware, Inc.
                    3c88160c-e0eb-4fe1-b4f6-011e45d74b10     Proseware SmartApp   2.3.4.500  Proseware, Inc.

This example returns information about all of the Business Central apps published on the DynamicsNAV90 server instance that are published by Proseware, Inc.

EXAMPLE 4

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Tenant 'Tenant1'

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/EULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about all of the Business Central apps installed for the tenant with an ID of Tenant1 on the DynamicsNAV90 server instance.

EXAMPLE 5

Get-NAVAppInfo -Path '.\Proseware SmartApp.navx'

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/ULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about the Business Central app from the package file provided.

EXAMPLE 6

Get-NAVAppInfo -ServerInstance DynamicsNAV90 -Tenant default

                    Id                 : 3c88160c-e0eb-4fe1-b4f6-011e45d74b10
                    Name               : Proseware SmartApp
                    Version            : 2.3.4.500
                    Publisher          : Proseware, Inc.
                    Brief              : First Proseware App
                    Description        : First Business Central app by Proseware
                    Compatibility Id   : 2.0.0.0
                    Privacy Statement  : http://www.proseware.com/SmartApp/privacypolicy.aspx
                    EULA               : http://www.proseware.com/SmartApp/ULA.aspx
                    Help               : http://www.proseware.com/SmartApp/Support.aspx
                    Url                : http://www.proseware.com/SmartApp/
                    Logo               : SmartLogo.png
                    ScreenShots        : SmartShot1.png, SmartShot2.png, SmartShot3.png
                    Capabilities       :
                    Prerequisites      :
                    Dependencies       :

This example returns information about all of the Business Central apps installed in a single tenant NAV server instance.

EXAMPLE 7

Get-NAVAppInfo -ServerInstance <server> -Tenant <tenantName> -TenantSpecificProperties

                    Id                     : a5d61952-f432-4ee6-8686-e8aa5d3dedc0
                    Name                   : Italian language (Switzerland)
                    Version                : 19.0.27273.0
                    Publisher              : Microsoft
                    ExtensionType          : ModernDev
                    Scope                  : Global
                    Tenant                 :
                    Is Installed           : False
                    Extension Data Version :
                    Needs Upgrade          : False
                    Sync State             : NotSynced
                    Is Published           : True

This example returns detailed information about the specific tenant in a single tenant NAV server instance.

Parameters

-Id

Specifies the ID of the Business Central app to be returned.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppId

Parameter sets

Properties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
TenantSpecificProperties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of the Business Central app to be returned.

Parameter properties

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

Parameter sets

Properties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
TenantSpecificProperties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Path

Specifies the path to a Business Central app Package file that you want to return.

Parameter properties

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

Parameter sets

PathWithServerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
Path
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Publisher

Specifies the publisher of the Business Central app to be returned.

Parameter properties

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

Parameter sets

Properties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
TenantSpecificProperties
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServerInstance

Specifies the Business Central Server instance to which the Business Central app is deployed, such as DynamicsNAV90.

Parameter properties

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

Parameter sets

Properties
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
TenantSpecificProperties
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
Tenant
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SymbolsOnly

Returns the list of published extensions published with SymbolsOnly

Parameter properties

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

Parameter sets

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

-Tenant

Specifies the ID of the tenant that you want to get the published Business Central apps for, such as Tenant1. Provide a value of 'default' if the specified server instance is not configured to run multiple tenants.

Parameter properties

Type:TenantId
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TenantId

Parameter sets

TenantSpecificProperties
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
Tenant
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
PathWithServerInstance
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TenantSpecificProperties

Indicates to include any properties of the Business Central apps that are specific to the provided tenant

Parameter properties

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

Parameter sets

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

-Version

Specifies the version of the Business Central app to be returned.

Parameter properties

Type:Version
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AppVersion

Parameter sets

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

Inputs

System.Guid

By property name: Id

System.String

By property name: Name

System.String

By property name: Publisher

System.Version

By property name: Version

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant

System.String

By value and by property name: Path

System.Management.Automation.SwitchParameter

By property name: SymbolsOnly

System.Management.Automation.SwitchParameter

By property name: TenantSpecificProperties

System.String

By value and by property name: ServerInstance