Share via


Unpublish-NAVApp

Unpublishes a Business Central app from the app catalog of the specified Business Central Server instance.

Syntax

Properties (Default)

Unpublish-NAVApp
    [-ServerInstance] <String>
    [[-Name] <String>]
    [[-Publisher] <String>]
    [[-Version] <Version>]
    [[-NavAppPackageId] <Guid>]
    [[-Tenant] <TenantId>]
    [-AppId <Guid>]
    [<CommonParameters>]

Path

Unpublish-NAVApp
    [-ServerInstance] <String>
    [-Path] <String>
    [[-Tenant] <TenantId>]
    [<CommonParameters>]

Description

Use the Unpublish-NAVApp cmdlet to remove a Business Central app from the application database of the specified Business Central Server instance. The Business Central app cannot be unpublished if it is currently installed for a tenant of the specified Business Central Server instance.

Examples

EXAMPLE 1

Unpublish-NAVApp -ServerInstance BC -Name 'Proseware SmartApp'

This example removes the Business Central app with the specified name from the BC server instance's app catalog.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 | Unpublish-NAVApp

This example removes the Business Central app returned from the Get-NAVAppInfo cmdlet from the BC server instance's app catalog.

EXAMPLE 3

Unpublish-NAVApp -ServerInstance BC -Path '.\Proseware SmartApp.app'

This example removes the Business Central app at the provided path from the BC server instance's app catalog.

Parameters

-AppId

Specifies the ID of the Business Central App to be uninstalled.

Parameter properties

Type:Guid
Default value:00000000-0000-0000-0000-000000000000
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

-Name

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

The results must return only a single Business Central app to successfully unpublished.

Parameter properties

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

Parameter sets

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

-NavAppPackageId

Specifies the package ID of the App to be unpublished.

The results must return only a single Business Central App to successfully unpublish.

Type:Guid
Default value:00000000-0000-0000-0000-000000000000
Supports wildcards:False
DontShow:False
Properties
Position:23
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 unpublish.

Parameter properties

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

Parameter sets

Path
Position:20
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 unpublished.

The results must return only a single Business Central app to successfully unpublish.

Parameter properties

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

Parameter sets

Properties
Position:21
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 that the Business Central app will be unpublished from, such as DynamicsNAV90.

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

-Tenant

Specifies the tenant to unpublish the package from if it was published into the tenant scope.

Note

In order to receive a signal for telemetry during an unpublish (or publish) operation, the -Tenant parameter must be set explicitly to the specific tenant or default.

Parameter properties

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

Parameter sets

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

-Version

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

The results must return only a single Business Central app to successfully unpublish.

Parameter properties

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

Parameter sets

Properties
Position:22
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.String

By value and by property name: ServerInstance

System.String

By property name: Path

System.String

By property name: Name

System.String

By property name: Publisher

System.Version

By property name: Version

System.Guid

By property name: Package ID