Set-FluxProcessDefinition

SYNOPSIS

Generated reference for the Set-FluxProcessDefinition Flux PowerShell command.

SYNTAX

Set-FluxProcessDefinition -Key <string> -Name <string> -ProcessKind <ProcessKind> -HiveApplication <HiveApplication> [-Description <string>] [-ExecutionGroupKey <string>] [-DefaultTimeoutSeconds <int>] [-DefaultRetryLimit <int>] [-Disabled] [-UpdatedBy <string>] [<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 use-case and administrator documentation for workflow examples.

PARAMETERS

-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

Configuration for the Flux application

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

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

-Key

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

Required: True
Position: Named
Default value: None
Accept pipeline input: False
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

-ProcessKind

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

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

-UpdatedBy

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

Required: False
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.ProcessDefinitionItem

NOTES

Generated from the Flux PowerShell module.

RELATED LINKS