Share via


Delete-NAVApplicationObject

Deletes Business Central application objects from a database.

Syntax

All (Default)

Delete-NAVApplicationObject
    [-DatabaseName] <String>
    [-DatabaseServer <String>]
    [-LogPath <String>]
    [-Filter <String>]
    [-SynchronizeSchemaChanges <String>]
    [-NavServerName <String>]
    [-NavServerInstance <String>]
    [-NavServerManagementPort <Int16>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DatabaseAuthentication

Delete-NAVApplicationObject
    [-DatabaseName] <String>
    -Username <String>
    -Password <String>
    [-DatabaseServer <String>]
    [-LogPath <String>]
    [-Filter <String>]
    [-SynchronizeSchemaChanges <String>]
    [-NavServerName <String>]
    [-NavServerInstance <String>]
    [-NavServerManagementPort <Int16>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Delete-NAVApplicationObject function deletes objects from the specified database. A filter can be specified to select the application objects to be deleted.

Examples

EXAMPLE 1

Delete-NAVApplicationObject -DatabaseName MyApp -Filter 'Type=Codeunit;Id=1..10'

Deletes codeunits 1..10 from the MyApp database

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DatabaseName

Specifies the name of the database from which you want to delete objects.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DatabaseServer

Specifies the name of the SQL server instance to which the database you want to delete objects from is attached. The default value is the default instance on the local host (.).

Parameter properties

Type:String
Default value:.
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Specifies the filter that selects the objects to delete.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LogPath

Specifies the log folder.

Parameter properties

Type:String
Default value:"$Env:TEMP\NavIde\$([GUID]::NewGuid().GUID)"
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NavServerInstance

Specifies the Business Central Server instance that is being used.The default value is DynamicsNAV90.

Type:String
Default value:DynamicsNAV90
Supports wildcards:False
DontShow:False
(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NavServerManagementPort

Specifies the port on the Business Central Server server that the Business Central Windows PowerShell cmdlets access. The default value is 7045.

Type:Int16
Default value:7045
Supports wildcards:False
DontShow:False
(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NavServerName

Specifies the name of the server that hosts the Business Central Server instance, such as MyServer.

Type:String
Default value:None
Supports wildcards:False
DontShow:False
(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Password

The password to use with the username parameter to authenticate to the database. If you do not specify a user name and password, then the command uses the credentials of the current Windows user to authenticate to the database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DatabaseAuthentication
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SynchronizeSchemaChanges

Specifies the schema synchronization behaviour. The default value is 'Yes'.

Parameter properties

Type:String
Default value:Yes
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Username

The user name to use to authenticate to the database. The user name must exist in the database. If you do not specify a user name and password, then the command uses the credentials of the current Windows user to authenticate to the database.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DatabaseAuthentication
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe input to this function.

Outputs

None