Set GitHubRepositoryTeamPermission

Set-GitHubRepositoryTeamPermission

SYNOPSIS

Sets team permission for a repository on GitHub.

SYNTAX

TeamNameElements (Default)

Set-GitHubRepositoryTeamPermission [-OwnerName <String>] [-RepositoryName <String>] -TeamName <String>
 [-Permission <String>] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

TeamSlugElements

Set-GitHubRepositoryTeamPermission [-OwnerName <String>] [-RepositoryName <String>] -TeamSlug <String>
 [-Permission <String>] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

TeamSlugUri

Set-GitHubRepositoryTeamPermission -Uri <String> -TeamSlug <String> [-Permission <String>]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

TeamNameUri

Set-GitHubRepositoryTeamPermission -Uri <String> -TeamName <String> [-Permission <String>]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Sets team permission for a repository on GitHub.

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

EXAMPLES

EXAMPLE 1

Set-GitHubRepositoryTeamPermission -Uri https://github.com/microsoft/PowerShellForGitHub -TeamName Devs -Permission Push

Sets the Push permission for the Devs team on the microsoft/PowerShellForGitHub repository.

EXAMPLE 2

Set-GitHubRepositoryTeamPermission -OwnerName microsoft -RepositoryName PowerShellForGitHub -TeamName Admins -Permission Admin

Sets the Admin permission for the Admin team on the microsoft/PowerShellForGitHub repository.

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

-OwnerName

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

Type: System.String
Parameter Sets: TeamNameElements, TeamSlugElements
Aliases:

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

-Permission

The permission to grant the team on this repository. Can be one of:

• Pull - team members can pull, but not push to or administer this repository.
• Push - team members can pull and push, but not administer this repository.
• Admin - team members can pull, push and administer this repository.
• Maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
• Triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

Type: System.String
Parameter Sets: (All)
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: TeamNameElements, TeamSlugElements
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: TeamNameElements, TeamNameUri
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: TeamSlugElements, TeamSlugUri
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: TeamSlugUri, TeamNameUri
Aliases: RepositoryUrl

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

-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

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

NOTES

RELATED LINKS