Dismount-NAVTenantDatabase

The shared schema feature is for use in conjunction only with Microsoft hosted offerings in Dynamics 365, is unsupported in Business Central, and may not be used outside Dynamics 365.

Syntax

Dismount-NAVTenantDatabase
        [-Id] <TenantDatabaseId>
        [-ServerInstance] <String>
        [-Force]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

Use the Dismount-NAVTenantDatabase cmdlet to dismount a tenant database on the specified Business Central Server instance. All active user sessions that access the tenant will end.

Examples

EXAMPLE 1

Dismount-NAVTenantDatabase -ServerInstance BC -Id 'Test@localhost'

This example dismounts the tenant database with Id Test@localhost from the specified server instance.

EXAMPLE 2

Dismount-NAVTenantDatabase BC 'Test@localhost'

This example dismounts the tenant database with Id Test@localhost from the specified server instance without being explicit about parameter names.

EXAMPLE 3

Get-NAVTenantDatabase BC | Dismount-NAVTenantDatabase BC

This example gets the tenant database information from the Business Central Server instance and passes the information to the Dismount-NAVTenantDatabase cmdlet. The tenant databases are then dismounted.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

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

Specifies the ID of the tenant database to be dismounted, such as 'Test@localhost'. This parameter is required.

Specifies the ID of the tenant database to be dismounted, such as 'Test@localhost'. This parameter is required.

Type:TenantDatabaseId
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServerInstance

Specifies the name of a Business Central Server instance, for example, BC or myinstance. You can specify either the full name of an instance, such as MicrosoftDynamicsNavServer$myinstance or the short name such as myinstance.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

Microsoft.Dynamics.Nav.Types.TenantDatabaseId

By property name: Id

System.String

ServerInstance