Skip to content

Get GitHubTeam

Howard Wolosky edited this page Oct 5, 2020 · 1 revision

Get-GitHubTeam

SYNOPSIS

Retrieve a team or teams within an organization or repository on GitHub.

SYNTAX

Elements (Default)

Get-GitHubTeam [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>] [<CommonParameters>]

TeamName

Get-GitHubTeam [-OwnerName <String>] [-RepositoryName <String>] [-Uri <String>] [-OrganizationName <String>]
 -TeamName <String> [-AccessToken <String>] [<CommonParameters>]

Uri

Get-GitHubTeam -Uri <String> [-AccessToken <String>] [<CommonParameters>]

TeamSlug

Get-GitHubTeam -OrganizationName <String> -TeamSlug <String> [-AccessToken <String>] [<CommonParameters>]

Organization

Get-GitHubTeam -OrganizationName <String> [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Retrieve a team or teams within an organization or repository on GitHub.

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

EXAMPLES

EXAMPLE 1

Get-GitHubTeam -OrganizationName PowerShell

PARAMETERS

-AccessToken

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.

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

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

-OrganizationName

The name of the organization.

Type: System.String
Parameter Sets: TeamName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: System.String
Parameter Sets: TeamSlug, Organization
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OwnerName

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

Type: System.String
Parameter Sets: Elements, TeamName
Aliases:

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

-RepositoryName

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

Type: System.String
Parameter Sets: Elements, TeamName
Aliases:

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

-TeamName

The name of the specific team to retrieve. Note: This will be slower than querying by TeamSlug since it requires retrieving all teams first.

Type: System.String
Parameter Sets: TeamName
Aliases:

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

-TeamSlug

The slug (a unique key based on the team name) of the specific team to retrieve.

Type: System.String
Parameter Sets: TeamSlug
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: TeamName
Aliases: RepositoryUrl

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: System.String
Parameter Sets: Uri
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.Organization

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

GitHub.Team

OUTPUTS

GitHub.Team

GitHub.TeamSummary

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally