Remove GitHubGistComment

Remove-GitHubGistComment

SYNOPSIS

Removes/deletes a comment from a gist on GitHub.

SYNTAX

Remove-GitHubGistComment [-Gist] <String> [-Comment] <Int64> [-Force] [-AccessToken <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes/deletes a comment from a gist on GitHub.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Remove-GitHubGist -Gist 6cad326836d38bd3a7ae -Comment 12324567

Removes the specified comment from octocat's "hello_world.rb" gist (assuming you have permission).

EXAMPLE 2

Remove-GitHubGist -Gist 6cad326836d38bd3a7ae -Comment 12324567 -Confirm:$false

Removes the specified comment from octocat's "hello_world.rb" gist (assuming you have permission). Will not prompt for confirmation, as -Confirm:$false was specified.

EXAMPLE 3

Remove-GitHubGist -Gist 6cad326836d38bd3a7ae -Comment 12324567 -Force

Removes the specified comment from octocat's "hello_world.rb" gist (assuming you have permission). Will not prompt for confirmation, as -Force was specified.

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Comment

The ID of the comment to remove from the gist.

Type: System.Int64
Parameter Sets: (All)
Aliases: GistCommentId

Required: True
Position: 3
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

If this switch is specified, you will not be prompted for confirmation of command execution.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Gist

The ID of the specific gist that you wish to remove the comment from.

Type: System.String
Parameter Sets: (All)
Aliases: GistId

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

GitHub.Gist

GitHub.GistComment

GitHub.GistCommit

GitHub.GistFork

GitHub.GistSummary

OUTPUTS

NOTES

RELATED LINKS