Share via

Remove-NAVWebService

  • Reference
Module:
Microsoft.BusinessCentral.Management

Removes the specified web services from the application that is mounted against the specified Business Central Server instance.

Syntax

Remove-NAVWebService
      -ObjectType <ObjectType>
      -ServiceName <String>
      [-ServerInstance] <String>
      [-Force]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Use the Remove-NAVWebService cmdlet to delete the web services that have been created in the application that is mounted against the specified Business Central Server instance.

Examples

EXAMPLE 1

Remove-NAVWebService -ServerInstance BC -ServiceName Customer -ObjectType Page

This example uses the Remove-NAVWebService cmdlet to remove a web service that is based on a page object and has the name Customer.

Parameters

-Confirm

Prompts you for confirmation before executing the command.

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

-ObjectType

Specifies the type of the object that the web service exposes. SOAP web services and ODATA web services support Create, Read, Update, and Delete operations for page objects. SOAP web services support codeunit objects. ODATA web services support query objects as read-only. For more information, see "Overview of Business Central Web Services" in the Developer and ITPro documentation for Business Central.

Type:ObjectType
Accepted values:CodeUnit, Page, Query
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProgressAction

A common PowerShell parameter that determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider. Learn more.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
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

-ServiceName

The name of the web service that you want to remove.

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

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

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