Get-NAVAppTenant
Gets the tenants where the specified Business Central app is installed.
Syntax
Properties (Default)
Get-NAVAppTenant
[-ServerInstance] <String>
[-Id <Guid>]
[-Name <String>]
[-Publisher <String>]
[-Version <Version>]
[-PackageId <Guid>]
[-IncludeFailed]
[<CommonParameters>]
Path
Get-NAVAppTenant
[-ServerInstance] <String>
-Path <String>
[-IncludeFailed]
[<CommonParameters>]
Description
Use the Get-NAVAppTenant cmdlet to get the tenants where the specified Business Central app is installed. You can specify the Business Central app by name, publisher, or version.
You can use the returned list of tenants to apply general changes, such as uninstalling the Business Central app for all tenants that currently have it installed.
Examples
EXAMPLE 1
Get-NavAppTenant -ServerInstance DynamicsNAV90 -Name 'ProseWare SmartApp' -Version 2.3.4.500
Id State
---- ---------
Tenant1 Mounted
Tenant2 Mounted
Tenant4 Mounted
This example gets the tenants on the DynamicsNAV90 server instance that have the version 2.3.4.500 of the Proseware SmartApp installed.
EXAMPLE 2
Get-NavAppTenant -ServerInstance DynamicsNAV90 -Name 'ProseWare SmartApp' -Version 2.3.4.500 | Uninstall-NAVApp -ServerInstance DynamicsNAV90 -Name 'Proseware SmartApp' -Version 2.3.4.500
This example gets the tenants on the DynamicsNAV90 server instance that have the version 2.3.4.500 of the Proseware SmartApp installed and then uninstalls that Business Central app for each of those tenants by passing the tenants to the Uninstall-NAVApp cmdlet.
Parameters
-Id
Specifies the ID of the Business Central app to be returned.
Parameter properties
| Type: | Guid |
| Default value: | 00000000-0000-0000-0000-000000000000 |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AppId |
Parameter sets
Properties
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeFailed
Indicates if failed tenants should be included in the list.
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 |
-Name
Specifies the name of the Business Central app that you want to see a list of tenants where it is installed.
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 |
-PackageId
Specifies the package ID of the Business Central App that you want to see a list of tenants where it is installed.
Parameter properties
| Type: | Guid |
| Default value: | 00000000-0000-0000-0000-000000000000 |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | NavAppPackageId |
Parameter sets
Properties
| Position: | Named |
| 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 for the Business Central app that you want to see a list of tenants where it is installed.
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 see a list of tenants where it is installed.
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 deployed 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 |
-Version
Specifies the version of the Business Central app that you want to see a list of tenants where it is installed.
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.Guid
By property name: Id
System.String
By property name: Name
System.String
By property name: Publisher
System.Version
By property name: Version
System.Guid
By property name: PackageId
System.String
By property name: Path
System.Management.Automation.SwitchParameter
By property name: IncludeFailed