Install-GitHubApp¶
SYNOPSIS¶
Install an app
SYNTAX¶
__AllParameterSets (Default)¶
Install-GitHubApp -ClientID <string> [-RepositorySelection <string>] [-Repositories <string[]>]
[-Context <Object>] [<CommonParameters>]
EnterpriseOrganization¶
Install-GitHubApp -Enterprise <string> -Organization <string> -ClientID <string>
[-RepositorySelection <string>] [-Repositories <string[]>] [-Context <Object>] [<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
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¶
-ClientID¶
The client ID of the GitHub App to install.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Enterprise¶
The enterprise slug or ID.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: EnterpriseOrganization
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Organization¶
The organization name. The name is not case sensitive.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: EnterpriseOrganization
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Repositories¶
The names of the repositories to which the installation will be granted access.
Type: System.String[]
DefaultValue: '@()'
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-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: System.String
DefaultValue: selected
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
System.String¶
{{ Fill in the Description }}