Set-Gist

Synopsis

Set Attributes of a Gist Object.

Syntax

Set-Gist -Id <string[]> [-Description <string>] [-WhatIf] [-Confirm]  [<CommonParameters>]

Set-Gist -Id <string[]> [-Star <bool>] [-WhatIf] [-Confirm]  [<CommonParameters>]

Aliases

None.

Description

Sets attributes of a Gist Object using the currently authenticated user context.

Parameters

-Confirm
    
    Required?                    false
    Position?                    Named
    Accept pipeline input?       false
    Parameter set name           (All)
    Aliases                      cf
    Dynamic?                     false
    
-Description <string>
    Description of the Gist Object.
    
    Required?                    false
    Position?                    Named
    Accept pipeline input?       false
    Parameter set name           Description
    Aliases                      None
    Dynamic?                     false
    
-Id <string[]>
    The Id of the Gist Object.
    
    Required?                    true
    Position?                    Named
    Accept pipeline input?       true (ByValue, ByPropertyName)
    Parameter set name           (All)
    Aliases                      None
    Dynamic?                     false
    
-Star <bool>
    The Starred state of a Gist Object.
    
    Required?                    false
    Position?                    Named
    Accept pipeline input?       false
    Parameter set name           Star
    Aliases                      None
    Dynamic?                     false
    
-WhatIf
    
    Required?                    false
    Position?                    Named
    Accept pipeline input?       false
    Parameter set name           (All)
    Aliases                      wi
    Dynamic?                     false
    
<CommonParameters>
    This cmdlet supports the common parameters: Verbose, Debug,
    ErrorAction, ErrorVariable, WarningAction, WarningVariable,
    OutBuffer, PipelineVariable, and OutVariable. For more information, see 
    about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

System.String[]

Represents text as a sequence of UTF-16 code units.

Outputs

System.Void

Specifies a return value type for a method that does not return a value.

Notes

There must be an Authenticated User Context to interact with Gist Objects.

Example 1

Marks the Gist a5b60bdf7955e029a500 as starred.

PS C:\> Set-Gist -Id a5b60bdf7955e029a500 -Star:$true

Example 2

Sets the description for Gist a5b60bdf7955e029a500.

PS C:\> Set-Gist -Id a5b60bdf7955e029a500 -Description 'Here is a new description.'