Set-NAVCompany

SYNOPSIS

Changes properties of a Business Central company.

SYNTAX

Set-NAVCompany [-Tenant <TenantId>] [-CompanyName] <String> [-CompanyDisplayName <String>]
 [-ServerInstance] <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Use the Set-NAVCompany cmdlet to change properties of a company in a Business Central database.

EXAMPLES

EXAMPLE 1

Set-NAVCompany -ServerInstance BusinessCentral -CompanyName 'CRONUS International Ltd.' -Tenant CRONUS -CompanyDisplayName 'CRONUS'

This example sets the display name of the company 'CRONUS International Ltd.' to 'CRONUS.'. The company already exists in tenant database 'CRONUS', which is mounted against the server instance 'BusinessCentral'.

PARAMETERS

-CompanyDisplayName

Specifies the new display name of the company.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CompanyName

Specifies the name of the company that you want to modify.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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
Parameter Sets: (All)
Aliases:

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

-ServerInstance

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Tenant

Specifies the ID of the tenant that contains the company to be modified, such as Tenant1 or Tenant2. This parameter is required unless the specified service instance is not configured to run multiple tenants.

Type: TenantId
Parameter Sets: (All)
Aliases: Id

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Dynamics.Nav.Types.TenantId

By property name: Tenant

System.String

By property name: CompanyName

System.String

By property name: NewCompanyName

System.String

ServerInstance

OUTPUTS

NOTES

Copy-NAVCompany

Get-NAVCompany

Remove-NAVCompany

Rename-NAVCompany