Dismount-NAVTenantDatabase
DO NOT USE: This cmdlet is for internal use only. It can't be used for Business Central on-premises tenants. For information about managing on-premises tenants, see https://go.microsoft.com/fwlink/?linkid=2153727.
Dismount-NAVTenantDatabase
[-Id] <TenantDatabaseId>
[-ServerInstance] <String>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]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.
Dismount-NAVTenantDatabase -ServerInstance BC -Id 'Test@localhost'This example dismounts the tenant database with Id Test@localhost from the specified server instance.
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.
Get-NAVTenantDatabase BC | Dismount-NAVTenantDatabase BCThis 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.
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
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 |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Microsoft.Dynamics.Nav.Types.TenantDatabaseId
By property name: Id
System.String
ServerInstance