Get-NAVAppTenant

  • Reference
Module:
Microsoft.BusinessCentral.Apps.Management

Gets the tenants where the specified Business Central app is installed.

Syntax

Get-NAVAppTenant
   [-ServerInstance] <String>
   [-Id <Guid>]
   [-Name <String>]
   [-Publisher <String>]
   [-Version <Version>]
   [-PackageId <Guid>]
   [-IncludeFailed]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-NAVAppTenant
   [-ServerInstance] <String>
   -Path <String>
   [-IncludeFailed]
   [-ProgressAction <ActionPreference>]
   [<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 BC -Name 'ProseWare SmartApp' -Version 2.3.4.500

          Id                    State
          ----                  ---------
          Tenant1               Mounted
          Tenant2               Mounted
          Tenant4               Mounted

This example gets the tenants on the BC server instance that have the version 2.3.4.500 of the Proseware SmartApp installed.

EXAMPLE 2

Get-NavAppTenant -ServerInstance BC -Name 'ProseWare SmartApp' -Version 2.3.4.500 | Uninstall-NAVApp -ServerInstance BC -Name 'Proseware SmartApp' -Version 2.3.4.500

This example gets the tenants on the BC 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.

Type:Guid
Aliases:AppId
Position:Named
Default value:00000000-0000-0000-0000-000000000000
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-IncludeFailed

Indicates if failed tenants should be included in the list.

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

-Name

Specifies the name of the Business Central app that you want to see a list of tenants where it is installed.

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

-PackageId

Specifies the package ID of the Business Central App that you want to see a list of tenants where it is installed.

Type:Guid
Aliases:NavAppPackageId
Position:Named
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 for the Business Central app that you want to see a list of tenants where it is installed.

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 see a list of tenants where it is installed.

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 deployed to, such as BC.

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

-Version

Specifies the version of the Business Central app that you want to see a list of tenants where it is installed.

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