Skip to content

Remove GitHubRepositoryTeamPermission

Howard Wolosky edited this page Jan 5, 2021 · 1 revision

Remove-GitHubRepositoryTeamPermission

SYNOPSIS

Removes team permission for a repository on GitHub.

SYNTAX

TeamNameElements (Default)

Remove-GitHubRepositoryTeamPermission [-OwnerName <String>] [-RepositoryName <String>] -TeamName <String>
 [-Force] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

TeamSlugElements

Remove-GitHubRepositoryTeamPermission [-OwnerName <String>] [-RepositoryName <String>] -TeamSlug <String>
 [-Force] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

TeamSlugUri

Remove-GitHubRepositoryTeamPermission -Uri <String> -TeamSlug <String> [-Force] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

TeamNameUri

Remove-GitHubRepositoryTeamPermission -Uri <String> -TeamName <String> [-Force] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes team permission for a repository on GitHub.

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

EXAMPLES

EXAMPLE 1

Remove-GitHubRepositoryTeamPermission -Uri https://github.com/microsoft/PowerShellForGitHub -TeamName Devs

Removes the permission for the Devs team on the microsoft/PowerShellForGitHub repository.

EXAMPLE 2

Remove-GitHubRepositoryTeamPermission -OwnerName microsoft -RepositoryName PowerShellForGitHub -TeamName Admins

Removes the 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

-Force

If this switch is specified, you will not be prompted for confirmation of 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

-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

-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 remove. 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 remove.

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

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally