Sync-FluxProcessDefinition

SYNOPSIS

Generated reference for the Sync-FluxProcessDefinition Flux PowerShell command.

SYNTAX

Sync-FluxProcessDefinition -InputObject <ProcessStepInput[]> -Name <string> -ProcessKind <ProcessKind> -HiveApplication <HiveApplication> [-Description <string>] [-ExecutionGroupKey <string>] [-DefaultTimeoutSeconds <int>] [-DefaultRetryLimit <int>] [-Disabled] [-NoRemove] [-ChangedBy <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This reference page is generated from the Flux PowerShell module metadata. It documents the command contract while narrative help content is completed.

EXAMPLES

See related workflow and administrator documentation for examples.

PARAMETERS

-ChangedBy

Audit user for created, changed and deleted records; defaults to the current user.

Type: String
Parameter Sets: (All)
Aliases: None

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

-DefaultRetryLimit

Type: Int32
Parameter Sets: (All)
Aliases: None

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

-DefaultTimeoutSeconds

Type: Nullable`1
Parameter Sets: (All)
Aliases: None

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

-Description

Type: String
Parameter Sets: (All)
Aliases: None

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

-Disabled

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

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

-ExecutionGroupKey

Type: String
Parameter Sets: (All)
Aliases: None

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

-HiveApplication

Type: HiveApplication
Parameter Sets: (All)
Aliases: None

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

-InputObject

The complete desired step set. Missing sequences are removed unless NoRemove is set.

Type: ProcessStepInput[]
Parameter Sets: (All)
Aliases: None

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

-Name

Type: String
Parameter Sets: (All)
Aliases: None

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

-NoRemove

Preserve existing sequences absent from the supplied steps.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

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

-ProcessKind

Type: ProcessKind
Parameter Sets: (All)
Aliases: None

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

CommonParameters

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

INPUTS

None

OUTPUTS

Flux.Hive.Application.Process.Definition.Sync.SyncProcessDefinitionResult

NOTES

Generated from the Flux PowerShell module.

RELATED LINKS