Change the value of a configuration property for the PowerShellForGitHub module, for the session only, or globally for this user.

Set-GitHubConfiguration [-ApiHostName <String>] [-ApplicationInsightsKey <String>] [-DefaultNoStatus]
 [-DefaultOwnerName <String>] [-DefaultRepositoryName <String>] [-DisableLogging] [-DisablePiiProtection]
 [-DisablePipelineSupport] [-DisableSmarterObjects] [-DisableTelemetry] [-DisableUpdateCheck]
 [-LogPath <String>] [-LogProcessId] [-LogRequestBody] [-LogTimeAsUtc] [-MultiRequestProgressThreshold <Int32>]
 [-RetryDelaySeconds <Int32>] [-SuppressNoTokenWarning] [-SuppressTelemetryReminder]
 [-WebRequestTimeoutSec <Int32>] [-SessionOnly] [-WhatIf] [-Confirm] [<CommonParameters>]

Change the value of a configuration property for the PowerShellForGitHub module, for the session only, or globally for this user.

A single call to this method can set any number or combination of properties.

To change any of the boolean/switch properties to false, specify the switch, immediately followed by ":$false" with no space.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

Set-GitHubConfiguration -WebRequestTimeoutSec 120 -SuppressNoTokenWarning

Changes the timeout permitted for a web request to two minutes, and additionally tells the module to never warn about no Access Token being configured. These settings will be persisted across future PowerShell sessions.

Set-GitHubConfiguration -DisableLogging -SessionOnly

Disables the logging of any activity to the logfile specified in LogPath, but for this session only.

Set-GitHubConfiguration -ApiHostName "github.contoso.com"

Sets all requests to connect to a GitHub Enterprise server running at github.contoso.com.

The hostname of the GitHub instance to communicate with. Defaults to 'github.com'. Provide a different hostname when using a GitHub Enterprise server. Do not include the HTTP/S prefix, and do not include 'api'. For example, use "github.contoso.com".

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Change the Application Insights instance that telemetry will be reported to (if telemetry hasn't been disabled via DisableTelemetry).

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Control if the -NoStatus switch should be passed-in by default to all methods. The -NoStatus switch has been deprecated. Commands in this module no longer display status on the console, thus passing in -NoStatus to a command no longer has any impact. Therefore, the value of this configuration setting also no longer has any impact on command execution.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

The owner name that should be used with a command that takes OwnerName as a parameter when no value has been supplied.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

The owner name that should be used with a command that takes RepositoryName as a parameter when no value has been supplied.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specify this switch to stop the module from logging all activity to a log file located at the location specified by LogPath.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specify this switch to disable the hashing of potential PII data prior to submitting the data to telemetry (if telemetry hasn't been disabled via DisableTelemetry).

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

By default, this module will modify all objects returned by the API calls by adding additional, consistent properties to those objects which ease pipelining those objects into other functions. This is highly convenient functionality. You would only want to disable this functionality if you are experiencing some edge case problems and are awaiting a proper fix.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

By default, this module will modify all objects returned by the API calls to update any properties that can be converted to objects (like strings for Date/Time's being converted to real DateTime objects). Enable this property if you desire getting back the unmodified version of the object from the API.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specify this switch to stop the module from reporting any of its usage (which would be used for diagnostics purposes).

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specify this switch to stop the daily update check with PowerShellGallery which can inform you when there is a newer version of this module available.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

The location of the log file that all activity will be written to if DisableLogging remains $false.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

If specified, the Process ID of the current PowerShell session will be included in each log entry. This can be useful if you have concurrent PowerShell sessions all logging to the same file, as it would then be possible to filter results based on ProcessId.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

If specified, the JSON body of the REST request will be logged to verbose output. This can be helpful for debugging purposes.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

If specified, all times logged will be logged as UTC instead of the local timezone.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Some commands may require sending multiple requests to GitHub. In some situations, getting the entirety of the request might take 70+ requests occurring over 20+ seconds. A progress bar will be shown (displaying which sub-request is being executed) if the number of requests required to complete this command is greater than or equal to this configuration value. Set to 0 to disable this feature.

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

The number of seconds to wait before retrying a command again after receiving a 202 response.

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

By default, this method will store the configuration values in a local file so that changes persist across PowerShell sessions. If this switch is provided, the file will not be created/updated and the specified configuration changes will only remain in memory/effect for the duration of this PowerShell session.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

If an Access Token has not been configured, this module will provide a warning to the user informing them of this, once per session. If it is expected that this module will regularly be used without configuring an Access Token, specify this switch to always suppress that warning message.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

When telemetry is enabled, a warning will be printed to the console once per session informing users that telemetry is occurring. Setting this value will suppress that message from showing up ever again.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

The number of seconds that should be allowed before an API request times out. A value of 0 indicates an infinite timeout, however experience has shown that PowerShell doesn't seem to always honor inifinite timeouts. Hence, this value can be configured if need be.

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.