Skip to content

Remove-GitHubTeam

SYNOPSIS

Delete a team

SYNTAX

Remove-GitHubTeam [-Organization] <String> [-Name] <String> [[-Context] <String>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

To delete a team, the authenticated user must be an organization owner or team maintainer. If you are an organization owner, deleting a parent team will delete all of its child teams as well.

EXAMPLES

EXAMPLE 1

Remove-GitHubTeam -Organization 'github' -Name 'team-name'

PARAMETERS

-Organization

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases: Org

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

-Name

The slug of the team name.

Type: String
Parameter Sets: (All)
Aliases: Team, TeamName, slug, team_slug

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

-Context

The context to run the command in

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: (Get-GitHubConfig -Name DefaultContext)
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

System.Void

NOTES

Delete a team