For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-PSUWorkflow

Creates a new workflow definition.

SYNOPSIS

Creates a new workflow definition.

SYNTAX

New-PSUWorkflow -Name <String> [-Description <String>] [-Definition <String>] [-Module <String>]
 [-ReadPermission <String>]
 [-WorkflowParameters <System.Collections.Generic.List`1[PowerShellUniversal.WorkflowParameter]>]
 [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

DESCRIPTION

Builds a workflow object from the supplied metadata and persists it in PowerShell Universal. Workflow parameters can be created separately and attached during creation.

EXAMPLES

Example 1

PS C:\> New-PSUWorkflow -Name DailyMaintenance -Description "Nightly cleanup" -Definition "Write-Host 'run'" -Module Ops -ReadPermission Operators

Creates a workflow named DailyMaintenance with a simple definition and read permission requirement.

PARAMETERS

-AppToken

Specifies the app token to use when authenticating to the PowerShell Universal management API.

-ComputerName

Specifies the URL or host name of the target PowerShell Universal instance. Bare host names are normalized to an http://:5000 URL.

-Cookies

Reuses and persists authentication cookies for the current PowerShell session.

-Credential

Specifies the credentials to use for Basic authentication against the PowerShell Universal management API.

-Definition

Specifies the workflow definition content to store for the workflow.

-Description

Specifies a description for the resource.

-Integrated

Uses the in-process integrated management client when the cmdlet runs inside PowerShell Universal.

-Module

Specifies the PowerShell module name to use.

-Name

Specifies the name of the resource.

-ReadPermission

Specifies the permission required to read the workflow.

-TrustCertificate

Allows connections to servers with untrusted TLS certificates.

-UseDefaultCredentials

Uses the current Windows credentials when authenticating to the management API.

-WorkflowParameters

Specifies the workflow parameter definitions to attach to the workflow.

CommonParameters

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

INPUTS

None

OUTPUTS

System.Object

NOTES

Last updated

Was this helpful?