Uninstall-NAVApp

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

Uninstall a NAV App for a tenant.

Syntax

Uninstall-NAVApp
         [-ServerInstance] <String>
         -Name <String>
         [-Publisher <String>]
         [-Version <Version>]
         [-Tenant <TenantId>]
         [-PassThru]
         [-DoNotSaveData]
         [-ExclusiveAccessTicket <String>]
         [-Force]
         [<CommonParameters>]
Uninstall-NAVApp
         [-ServerInstance] <String>
         [-Tenant <TenantId>]
         -Path <String>
         [-PassThru]
         [-DoNotSaveData]
         [-ExclusiveAccessTicket <String>]
         [-Force]
         [<CommonParameters>]

Description

Use the Uninstall-NAVApp cmdlet to uninstall a NAV App for one or more tenants.

Examples

EXAMPLE 1

Uninstall-NAVApp -ServerInstance DynamicsNAV -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1'

This example uninstalls the NAV App with the provided name and version for the tenant with the ID Tenant1. If the NAV App contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance DynamicsNAV -Name 'Proseware SmartApp' -Version 2.3.4.500 | Uninstall-NAVApp -Tenant 'Tenant1'

This example uninstalls the NAV App returned from the Get-NAVAppInfo cmdlet for the tenant with the ID Tenant1. If the NAV App contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 3

Uninstall-NAVApp -ServerInstance DynamicsNAV -Path '.\Proseware SmartApp.app' -Tenant 'Tenant1'

This example uninstalls the NAV App at the provided path for the tenant with the ID Tenant1. If the NAV App contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 4

Get-NAVAppInfo -ServerInstance DynamicsNAV -Tenant 'Tenant1' | Uninstall-NAVApp -Tenant 'Tenant1'

This example uninstalls all of the NAV Apps that have been installed for the tenant with the ID Tenant1. If the NAV App contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 5

Uninstall-NAVApp -ServerInstance DynamicsNAV -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1' -DoNotSaveData

This example uninstalls the NAV App with the provided name and version for the tenant with the ID Tenant1. If the NAV App contains a schema change, the tenant database will be synchronized but since the DoNotSaveData switch was used any data in the NAV App fields being removed will not be saved.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

EXAMPLE 6

Uninstall-NAVApp -ServerInstance DynamicsNAV -Name 'Proseware SmartApp' -Version 2.3.4.500

This example uninstalls the NAV App with the provided name and version for a non-multitenant Dynamics NAV server instance. If the NAV App contains a schema change, the tenant database will be synchronized.
For V2 extensions, the Uninstall-NAVApp cmdlet does not handle synchronization, and in this case, the Sync-NAVApp cmdlet must be used.

Parameters

-DoNotSaveData

Specifies that the install should be executed without saving the NAV App data for a future install/upgrade of the NAV App.

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

-ExclusiveAccessTicket

Specifies the exclusive access ticket allowing this operation on the tenant in the exclusive access mode.

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

-Force

Forces the command to run without asking for user confirmation to uninstall NAV Apps with a dependency on the NAV App being uninstalled.

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

-Name

Specifies the name of the NAV App to be uninstalled.

The results must return only a single NAV App to successfully uninstall.

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

-PassThru

Returns a NAV App object for the uninstalled NAV App. The NAV App object contains the properties of the NAV App, such as name, publisher, version.

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

-Path

Specifies the path to a NAV App Package file that you want to uninstall for the tenant. The NAV App must have already been published to the server instance before uninstalling it for the tenant.

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

-Publisher

Specifies the publisher of the NAV App to be uninstalled.

The results must return only a single NAV App to successfully uninstall.

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

-ServerInstance

Specifies the Microsoft Dynamics NAV Server instance that the NAV App is published to, such as DynamicsNAV.

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

-Tenant

Specifies the ID of the tenant that you want to uninstall the NAV App for, such as Tenant1.

Type:TenantId
Aliases:Id
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Version

Specifies the version of the NAV App to be uninstalled.

The results must return only a single NAV App to successfully uninstall.

Type:Version
Aliases:AppVersion
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False