Invoke-FluxProcessDefinition

SYNOPSIS

Generated reference for the Invoke-FluxProcessDefinition Flux PowerShell command.

SYNTAX

Invoke-FluxProcessDefinition -Key <string> -HiveApplication <HiveApplication> [-TriggerKind <ProcessTriggerKind>] [-CorrelationId <guid>] [-ExternalHostName <string>] [-ExternalRunId <string>] [-TriggeredBy <string>] [-MachineName <string>] [-UserName <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

-CorrelationId

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

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

-ExternalHostName

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

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

-ExternalRunId

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

-MachineName

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

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

-TriggeredBy

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

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

-TriggerKind

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

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

-UserName

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.Run.Get.ProcessRunItem

NOTES

Generated from the Flux PowerShell module.

RELATED LINKS