Test GitHubAuthenticationConfigured - X-Guardian/PowerShellForGitHub GitHub Wiki

Test-GitHubAuthenticationConfigured

SYNOPSIS

Indicates if a GitHub API Token has been configured for this module via Set-GitHubAuthentication.

SYNTAX

Test-GitHubAuthenticationConfigured [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Indicates if a GitHub API Token has been configured for this module via Set-GitHubAuthentication.

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

EXAMPLES

EXAMPLE 1

Test-GitHubAuthenticationConfigured

Returns $true if the session is authenticated; $false otherwise

PARAMETERS

-Confirm

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

-WhatIf

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

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

Boolean

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️