Skip to content

Set GitHubProjectCard

Howard Wolosky edited this page Oct 5, 2020 · 2 revisions

Set-GitHubProjectCard

SYNOPSIS

Modify a GitHub Project Card.

SYNTAX

Note (Default)

Set-GitHubProjectCard -Card <Int64> [-Note <String>] [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Archive

Set-GitHubProjectCard -Card <Int64> [-Note <String>] [-Archive] [-PassThru] [-AccessToken <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Restore

Set-GitHubProjectCard -Card <Int64> [-Note <String>] [-Restore] [-PassThru] [-AccessToken <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Modify a GitHub Project Card.

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

EXAMPLES

EXAMPLE 1

Set-GitHubProjectCard -Card 999999 -Note UpdatedNote

Sets the card note to 'UpdatedNote' for the card with ID 999999.

EXAMPLE 2

Set-GitHubProjectCard -Card 999999 -Archive

Archives the card with ID 999999.

EXAMPLE 3

Set-GitHubProjectCard -Card 999999 -Restore

Restores the card with ID 999999.

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

-Archive

Archive a project card.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Archive
Aliases:

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

-Card

ID of the card to modify.

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

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

-Note

The note content for the card. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

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

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

-PassThru

Returns the updated Project Card. By default, this cmdlet does not generate any output. You can use "Set-GitHubConfiguration -DefaultPassThru" to control the default behavior of this switch.

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

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

-Restore

Restore a project card.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Restore
Aliases:

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

OUTPUTS

GitHub.ProjectCard

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally