Unpublish-NAVApp

  • Reference
Module:
Microsoft.BusinessCentral.Apps.Management

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

Syntax

Unpublish-NAVApp
         [-ServerInstance] <String>
         [-AppId <Guid>]
         [[-Name] <String>]
         [[-Publisher] <String>]
         [[-Version] <Version>]
         [[-NavAppPackageId] <Guid>]
         [[-Tenant] <TenantId>]
         [-ProgressAction <ActionPreference>]
         [<CommonParameters>]
Unpublish-NAVApp
         [-ServerInstance] <String>
         [-Path] <String>
         [[-Tenant] <TenantId>]
         [-ProgressAction <ActionPreference>]
         [<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.

Type:Guid
Position:Named
Default value:00000000-0000-0000-0000-000000000000
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:20
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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
Position:23
Default value:00000000-0000-0000-0000-000000000000
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Path

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

Type:String
Position:20
Default value:None
Required:True
Accept pipeline input:True
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

-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.

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

-ServerInstance

Specifies the Business Central Server instance that the Business Central app will be unpublished from, such as BC.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:TenantId
Aliases:TenantId
Position:246944
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:Version
Position:22
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

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