Register-NAVTenant

Reference

Module:: Microsoft.Dynamics.Nav.Management

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.

Syntax

Register-NAVTenant
        [-Tenant] <TenantId>
        [[-TenantDatabaseId] <TenantDatabaseId>]
        [[-BufferTenantId] <TenantId>]
        [-ServerInstance] <String>
        [-Force]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

A tenant database can contain one or more buffer tenants. A buffer tenant cannot be mounted on a Business Central Server instance until is changed to a normal tenant by using the Register-NAVTenant cmdlet. The Register-NAVTenant cmdlet can register any buffer tenant that is contained in the tenant databases that are mounted on the Business Central Server instance. There are three options for registering a buffer tenant.

There are basically two types of tenants: normal and buffer. A normal tenant is a tenant in the tenant database that can potentially be mounted on a Business Central Server instance, and eventually used and managed in a production environment. Tenants are by default normal tenants. A buffer tenant is a specific type of tenant that can be added to a tenant database. A buffer tenant is a kind of predefined tenant that typically contains some basic or demonstration data. Buffer tenants are useful in a deployment environment where you have to get new tenants up and running quickly on demand. A buffer tenant is created from a normal tenant by using the Set-NAVTenant cmdlet. For more information about buffer tenants and their use, see the help for the Set-NAVTenant cmdlet.

The output object of Register-NAVTenant contains all the details about the registered tenant.

Examples

EXAMPLE 1

Register-NAVTenant -ServerInstance 'NavServer' -Tenant 'TenantA'

This example registers an unspecified buffer tenant from one of the tenant databases mounted on the Business Central Server instance 'NavServer'. The selected buffer tenant is changed to a normal tenant and assigned the ID 'TenantA'. If successful, the returned object shows the tenant information, including which database the tenant is in.

EXAMPLE 2

Register-NAVTenant-ServerInstance 'NavServer' -Tenant 'TenantA' -TenantDatabaseId 'MyTenantDatabase1'

This example registers an unspecified buffer tenant from the tenant database 'MyTenantDatabase1' that is mounted on the Business Central Server instance 'NavServer'. The selected buffer tenant is changed to a normal tenant and assigned the ID 'TenantA'.

EXAMPLE 3

Register-NAVTenant -ServerInstance 'NavServer' -Tenant 'TenantA' -TenantDatabaseId 'MyTenantDatabase1' -BufferTenantId 'BufferTenant1'

This example registers the buffer tenant with the ID 'BufferTenant1' in the tenant database 'MyTenantDatabase1'. The buffer tenant is changed to a normal tenant and assigned the ID 'TenantA'.

Parameters

-BufferTenantId

Specifies the ID of the specific buffer tenant that you want to register, such as BufferTenant1. If you omit this parameter, then an unspecified buffer tenant will be selected from the tenant database.

Type:	TenantId
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

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

-Force

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

-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
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Tenant

Specifies the ID to assign the buffer tenant when it is changed to a normal tenant. This ID must be unique within the database in which the buffer tenant resides.

Type:	TenantId
Aliases:	Id
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TenantDatabaseId

Specifies the ID of the tenant database that contains the buffer tenant that you want to register. This parameter is required if you use the -BufferTenantId to specify a specific buffer tenant. If you are not using the -BufferTenantId parameter and you omit this parameter, then an unspecified buffer tenant will selected from any one of the mounted tenant databases.

Type:	TenantDatabaseId
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Id

Microsoft.Dynamics.Nav.Types.TenantDatabaseId

By property name: TenantDatabaseId