Stop-PnPWorkflowInstance

Stops a workflow instance

Syntax

Stop-PnPWorkflowInstance
    -Identity <WorkflowInstancePipeBind>
                            [-Force [<SwitchParameter>]]
                            [-Web <WebPipeBind>]
                            [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Stop-PnPWorkflowInstance -identity $wfInstance

Stops the workflow Instance

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forcefully terminate the workflow instead of cancelling. Works on errored and non-responsive workflows. Deletes all created tasks. Does not notify participants.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

The instance to stop

Type:WorkflowInstancePipeBind
Position:0
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False