Install-GitHubApp¶
SYNOPSIS¶
Install an app
SYNTAX¶
__AllParameterSets (Default)¶
Install-GitHubApp -ClientID <String> [-RepositorySelection <String>] [-Repositories <String[]>]
[-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
EnterpriseOrganization¶
Install-GitHubApp -Enterprise <String> -Organization <String> -ClientID <String>
[-RepositorySelection <String>] [-Repositories <String[]>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Installs the provided GitHub App on the specified target.
EXAMPLES¶
EXAMPLE 1¶
Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'selected' -Repositories 'repo1', 'repo2'
Install the GitHub App with - the client ID '123456' - the repository selection 'selected' - the repositories 'repo1' and 'repo2' on the organization 'org' in the enterprise 'msx'.
EXAMPLE 2¶
Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'all'
Install the GitHub App with - the client ID '123456' - the repository selection 'all' on the organization 'org' in the enterprise 'msx'.
PARAMETERS¶
-Enterprise¶
The enterprise slug or ID.
Type: String
Parameter Sets: EnterpriseOrganization
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Organization¶
The organization name. The name is not case sensitive.
Type: String
Parameter Sets: EnterpriseOrganization
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ClientID¶
The client ID of the GitHub App to install.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RepositorySelection¶
The repository selection for the GitHub App. Can be one of: - all - all repositories that the authenticated GitHub App installation can access. - selected - select specific repositories.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Selected
Accept pipeline input: False
Accept wildcard characters: False
-Repositories¶
The names of the repositories to which the installation will be granted access.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: @()
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: (Get-GitHubContext)
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.