Update-GitHubTeam

SYNOPSIS

Update a team

SYNTAX

Update-GitHubTeam [-Organization] <String> [-Slug] <String> [[-NewName] <String>] [[-Description] <String>]
 [[-Visible] <Boolean>] [[-Notifications] <Boolean>] [[-ParentTeamID] <Int32>] [[-Context] <Object>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

EXAMPLES

EXAMPLE 1

$params = @{
    Organization  = 'github'
    Slug          = 'team-name'
    NewName       = 'new team name'
    Description   = 'A new team'
    Visible       = $true
    Notifications = $true
    ParentTeamID  = 123456
}
Update-GitHubTeam @params

Updates the team with the slug 'team-name' in the github organization with the new name 'new team name', description 'A new team', visibility set to 'closed', notifications enabled, and the parent team ID set to 123456.

PARAMETERS

-Organization

The organization name. The name is not case sensitive. If you do not provide this parameter, the command will use the organization from the context.

Type: String
Parameter Sets: (All)
Aliases:

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

-Slug

The slug of the team name.

Type: String
Parameter Sets: (All)
Aliases:

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

-NewName

The new team name.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

The description of the team.

Type: String
Parameter Sets: (All)
Aliases:

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

-Visible

The level of privacy this team should have. The options are: For a non-nested team: - secret - only visible to organization owners and members of this team. - closed - visible to all members of this organization. Default: secret For a parent or child team: - closed - visible to all members of this organization. Default for child team: closed

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Notifications

The notification setting the team has chosen. The options are: notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications. Default: notifications_enabled

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ParentTeamID

The ID of a team to set as the parent team.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
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: 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

GitHubTeam

NOTES

Update a team

RELATED LINKS

https://psmodule.io/GitHub/Functions/Teams/Update-GitHubTeam