Start-NAVAppDataUpgrade
Upgrades a Business Central app to a specified tenant.
Syntax
Properties (Default)
Start-NAVAppDataUpgrade
[-ServerInstance] <String>
[-Name <String>]
[-Publisher <String>]
[-Version <Version>]
[-Tenant <TenantId>]
[-Language <LanguageSetting>]
[-ExclusiveAccessTicket <String>]
[-PassThru]
[-SkipVersionCheck]
[-SyncMode <NavAppSyncMode>]
[-Force]
[-AppId <Guid>]
[<CommonParameters>]
Path
Start-NAVAppDataUpgrade
[-ServerInstance] <String>
-Path <String>
[-Tenant <TenantId>]
[-Language <LanguageSetting>]
[-ExclusiveAccessTicket <String>]
[-PassThru]
[-SkipVersionCheck]
[-SyncMode <NavAppSyncMode>]
[-Force]
[<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.
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 |
-ExclusiveAccessTicket
Specifies the exclusive access ticket allowing this operation on the tenant in the exclusive access mode.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | LanguageSetting |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
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 |
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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 that you want to upgrade. The results must return only one Business Central app, otherwise nothing upgrades.
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 |
-ServerInstance
Specifies the Business Central Server instance that the Business Central app is published to, such as BC.
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 |
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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
Parameter properties
| Type: | NavAppSyncMode |
| Default value: | None |
| Accepted values: | Add, Clean, Development, ForceSync, None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| 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 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.
Parameter properties
| Type: | TenantId |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Id |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| 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 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.
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 |
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: 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.