Stop-GitHubWorkflowRun¶
SYNOPSIS¶
Cancel a workflow run
SYNTAX¶
Stop-GitHubWorkflowRun [[-Owner] <String>] [[-Repo] <String>] [-ID] <String>
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Cancels a workflow run using its run_id.
You can use this endpoint to cancel a workflow run that is in progress or waiting
EXAMPLES¶
EXAMPLE 1¶
Stop-GitHubWorkflowRun -Owner 'octocat' -Repo 'Hello-World' -ID 123456789
Cancels the workflow run with the ID 123456789 from the 'Hello-World' repository owned by 'octocat'
PARAMETERS¶
-Owner¶
{{ Fill Owner Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: (Get-GitHubContextSetting -Name Owner)
Accept pipeline input: False
Accept wildcard characters: False
-Repo¶
{{ Fill Repo Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: (Get-GitHubContextSetting -Name Repo)
Accept pipeline input: False
Accept wildcard characters: False
-ID¶
{{ Fill ID Description }}
Type: String
Parameter Sets: (All)
Aliases: workflow_id
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.