Share via

Start-NAVAppDataUpgrade

  • Reference
Module:
Microsoft.BusinessCentral.Apps.Management

Upgrades a Business Central app to a specified tenant.

Syntax

Start-NAVAppDataUpgrade
     [-ServerInstance] <String>
     [-Name <String>]
     [-Publisher <String>]
     [-Version <Version>]
     [-Tenant <TenantId>]
     [-Language <LanguageSetting>]
     [-ExclusiveAccessTicket <String>]
     [-PassThru]
     [-SkipVersionCheck]
     [-SyncMode <NavAppSyncMode>]
     [-Force]
     [-AppId <Guid>]
     [-ProgressAction <ActionPreference>]
     [<CommonParameters>]
Start-NAVAppDataUpgrade
     [-ServerInstance] <String>
     [-Tenant <TenantId>]
     -Path <String>
     [-Language <LanguageSetting>]
     [-ExclusiveAccessTicket <String>]
     [-PassThru]
     [-SkipVersionCheck]
     [-SyncMode <NavAppSyncMode>]
     [-Force]
     [-ProgressAction <ActionPreference>]
     [<CommonParameters>]

Description

Use the Start-NAVAppDataUpgrade cmdlet to upgrade the data from a old version of Business Central app to a new version of Business Central app in the tenant database.

Examples

EXAMPLE 1

Start-NAVAppDataUpgrade -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1'

This example upgrades the Business Central app with the specified name and version for the tenant with the ID Tenant1.

EXAMPLE 2

Get-NAVAppInfo -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 | Start-NAVAppDataUpgrade -Tenant 'Tenant1'

This example upgrades a Business Central app that is returned from the Get-NAVAppInfo cmdlet for the tenant with the ID Tenant1.

EXAMPLE 3

Start-NAVAppDataUpgrade -ServerInstance BC -Path '.\Proseware SmartApp.navx' -Tenant 'Tenant1'

This example upgrades the Business Central app at the specified path for the tenant with the ID Tenant1.

EXAMPLE 4

Start-NAVAppDataUpgrade -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1' -ExclusiveAccessTicket $ticket

This example upgrades the Business Central app with the specified name and version for the tenant with the ID Tenant1. Tenant1 is in exclusive access mode and $ticket is the exclusive access ticket.

EXAMPLE 5

Start-NAVAppDataUpgrade -ServerInstance BusinessCentral -Name 'Proseware SmartApp' -Version 2.3.4.500 -Tenant 'Tenant1' -SyncMode Add

This example synchronizes and upgrades the Business Central app with the specified name and version for the tenant with the ID Tenant1.

Parameters

-AppId

Specifies the publisher of the Business Central App that you want to upgrade. The results must return only one Business Central App, otherwise nothing upgrades.

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

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

-Language

Specifies the language version of Business Central app. The value must be a valid culture name for a language in Business Central, such as en-US or da-DK. If the specified language does not exist on the Business Central Server instance, then en-US is used.

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

-Name

Specifies the name of the Business Central app that you want to upgrade. The results must return only one Business Central app, otherwise nothing upgrades.

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

-PassThru

Returns a Business Central app object for the upgraded Business Central app. The Business Central app object contains the properties of the Business Central app, such as name, publisher, and version.

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

-Path

Specifies the path to a Business Central app package file that you want to upgrade for the tenant. The Business Central app must have already been published and synced to the server instance before you can upgrade it for the tenant.

Type:String
Position:Named
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 that you want to upgrade. The results must return only one Business Central app, otherwise nothing upgrades.

Type:String
Aliases:AppPublisher
Position:Named
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 is published to, such as BC.

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

-SkipVersionCheck

Specifies if we should check the version during the upgrade. By default if the version of the Business Central App was not changed we will not run upgrade. If you specify this parameter the upgrade will be executed again. This parameter cannot be used to downgrade the app - upgrading to a lower version will fail.

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

-SyncMode

Which sync mode should be executed while upgrading the app.

If the app is already synchronized, the upgrade process proceeds independently of the requested sync mode.

The supported synchronization modes for upgrade are 'Add', 'ForceSync' and 'None'. The last-mentioned is the default behavior.

Possible values: Add, Clean, Development, ForceSync, None

Type:NavAppSyncMode
Accepted values:Add, Clean, Development, ForceSync, None
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Tenant

Specifies the ID of the tenant that you want to upgrade the Business Central app for, such as Tenant1. You can specify the value 'default' if the specified server instance is not configured for multiple tenants. Alternatively, do not set the parameter.

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 Business Central app that you want to upgrade. The version of upgraded Business Central app must be greater than current installed/uninstalled Business Central app , otherwise nothing upgrades.

Type:Version
Aliases:AppVersion
Position:Named
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: 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 property name: Path

System.String

By value and by property name: ExclusiveAccessTicket

System.Management.Automation.SwitchParameter

Forces the command to run without asking for user confirmation.