Get-PnPWorkflowDefinition.md

external help file	applicable	schema
	SharePoint Server 2013, SharePoint Server 2016, SharePoint Online	2.0.0

Get-PnPWorkflowDefinition

SYNOPSIS

Return a workflow definition

SYNTAX

Get-PnPWorkflowDefinition [-PublishedOnly [<SwitchParameter>]]
                          [-Name <String>]
                          [-Web <WebPipeBind>]
                          [-Connection <SPOnlineConnection>]

DESCRIPTION

Returns a workflow definition

EXAMPLES

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

PS:> Get-PnPWorkflowDefinition -Name MyWorkflow

Gets an Workflow with the name "MyWorkflow".

------------------EXAMPLE 2------------------

PS:> Get-PnPWorkflowDefinition -Name MyWorkflow -PublishedOnly $false

Gets an Workflow with the name "MyWorkflow" that is published.

PARAMETERS

-Name

The name of the workflow

Type: String
Parameter Sets: (All)

Required: False
Position: 0
Accept pipeline input: False

-PublishedOnly

Return only the published workflows

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

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

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: 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
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

OUTPUTS

Microsoft.SharePoint.Client.WorkflowServices.WorkflowDefinition

RELATED LINKS

SharePoint Developer Patterns and Practices