Get-GitHubRepositoryBranch

NAME Get-GitHubRepositoryBranch



SYNOPSIS

Retrieve branches for a given GitHub repository.





SYNTAX

Get-GitHubRepositoryBranch [-OwnerName <String>] [-RepositoryName <String>] [-Name <String>] [-ProtectedOnly]

[-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]



Get-GitHubRepositoryBranch -Uri <String> [-Name <String>] [-ProtectedOnly] [-AccessToken <String>] [-NoStatus]

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





DESCRIPTION

Retrieve branches for a given GitHub repository.



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





PARAMETERS

-OwnerName <String>

Owner of the repository.

If not supplied here, the DefaultOwnerName configuration property value will be used.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RepositoryName <String>

Name of the repository.

If not supplied here, the DefaultRepositoryName configuration property value will be used.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Uri <String>

Uri for the repository.

The OwnerName and RepositoryName will be extracted from here instead of needing to provide

them individually.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

Name of the specific branch to be retieved. If not supplied, all branches will be retrieved.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProtectedOnly [<SwitchParameter>]



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-AccessToken <String>

If provided, this will be used as the AccessToken for authentication with the

REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NoStatus [<SwitchParameter>]

If this switch is specified, long-running commands will run on the main thread

with no commandline status update. When not specified, those commands run in

the background, enabling the command prompt to provide status information.

If not supplied here, the DefaultNoStatus configuration property value will be used.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

[PSCustomObject[]] List of branches within the given repository.





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-GitHubRepositoryBranch -OwnerName Microsoft -RepositoryName PowerShellForGitHub



Gets all branches for the specified repository.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-GitHubRepositoryBranch -Uri 'https://github.com/PowerShell/PowerShellForGitHub' -Name master



Gets information only on the master branch for the specified repository.











RELATED LINKS