Connect-GitHubApp¶
SYNOPSIS¶
Connects to GitHub as a installation using a GitHub App.
SYNTAX¶
All Installations (Default)¶
Connect-GitHubApp [-PassThru] [-Silent] [-Default] [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Filtered¶
Connect-GitHubApp [-User <String[]>] [-Organization <String[]>] [-Enterprise <String[]>] [-PassThru] [-Silent]
[-Default] [-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Installation object¶
Connect-GitHubApp -Installation <GitHubAppInstallation[]> [-PassThru] [-Silent] [-Default] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Installation ID¶
Connect-GitHubApp -ID <Int32[]> [-PassThru] [-Silent] [-Default] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Connects to GitHub using a GitHub App to generate installation access tokens and create contexts for targets.
Available target types: - User - Organization - Enterprise
EXAMPLES¶
EXAMPLE 1¶
Connect-GitHubApp
Connects to GitHub as all available targets using the logged in GitHub App.
EXAMPLE 2¶
Connect-GitHubApp -User 'octocat'
Connects to GitHub as the user 'octocat' using the logged in GitHub App.
EXAMPLE 3¶
Connect-GitHubApp -Organization 'psmodule' -Default
Connects to GitHub as the organization 'psmodule' using the logged in GitHub App and sets it as the default context.
EXAMPLE 4¶
Connect-GitHubApp -Enterprise 'msx'
Connects to GitHub as the enterprise 'msx' using the logged in GitHub App.
PARAMETERS¶
-User¶
The user account to connect to.
Type: String[]
Parameter Sets: Filtered
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Organization¶
The organization to connect to.
Type: String[]
Parameter Sets: Filtered
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Enterprise¶
The enterprise to connect to.
Type: String[]
Parameter Sets: Filtered
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True
-Installation¶
Installation objects from pipeline for parallel processing.
Type: GitHubAppInstallation[]
Parameter Sets: Installation object
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ID¶
The installation ID(s) to connect to directly. Accepts input from the pipeline by property name (e.g. objects with an ID property)
Type: Int32[]
Parameter Sets: Installation ID
Aliases: InstallationID
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PassThru¶
Passes the context object to the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Silent¶
Suppresses the output of the function.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: Quiet
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Default¶
Set as the default context.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Context¶
The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.
Type: Object
Parameter Sets: (All)
Aliases:
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.
INPUTS¶
OUTPUTS¶
System.Void¶
NOTES¶
Authenticating to the REST API