Set-GitHubConfig¶
SYNOPSIS¶
Set the GitHub configuration.
SYNTAX¶
Set-GitHubConfig [[-AccessTokenType] <String>] [[-AccessToken] <SecureString>]
[[-AccessTokenExpirationDate] <DateTime>] [[-ApiBaseUri] <String>] [[-ApiVersion] <String>]
[[-AuthType] <String>] [[-DeviceFlowType] <String>] [[-Owner] <String>] [[-RefreshToken] <SecureString>]
[[-RefreshTokenExpirationDate] <DateTime>] [[-Repo] <String>] [[-SecretVaultName] <String>]
[[-SecretVaultType] <String>] [[-Scope] <String>] [[-UserName] <String>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Set the GitHub configuration. Specific scopes can be set by using the parameters.
EXAMPLES¶
EXAMPLE 1¶
Set-GitHubConfig -APIBaseURI 'https://api.github.com" -APIVersion '2022-11-28'
Sets the App.API scope of the GitHub configuration.
EXAMPLE 2¶
Set-GitHubConfig -Name "MyFavouriteRepo" -Value 'https://github.com/PSModule/GitHub'
Sets a item called 'MyFavouriteRepo' in the GitHub configuration.
PARAMETERS¶
-AccessTokenType¶
Set the access token type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccessToken¶
Set the access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccessTokenExpirationDate¶
Set the access token expiration date.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiBaseUri¶
Set the API Base URI.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApiVersion¶
Set the GitHub API Version.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AuthType¶
Set the authentication type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeviceFlowType¶
Set the device flow type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Owner¶
Set the default for the Owner parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RefreshToken¶
Set the refresh token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RefreshTokenExpirationDate¶
Set the refresh token expiration date.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Repo¶
Set the default for the Repo parameter.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SecretVaultName¶
Set the secret vault name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SecretVaultType¶
Set the secret vault type.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Scope¶
Set the scope.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserName¶
Set the GitHub username.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
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: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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.