Set GitHubTeam

Set-GitHubTeam

SYNOPSIS

Updates a team within an organization on GitHub.

SYNTAX

ParentName (Default)

Set-GitHubTeam [-OrganizationName] <String> [-TeamName] <String> [-TeamSlug <String>] [-Description <String>]
 [-Privacy <String>] [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

ParentTeamName

Set-GitHubTeam [-OrganizationName] <String> [-TeamName] <String> [-TeamSlug <String>] [-Description <String>]
 [-Privacy <String>] [-ParentTeamName <String>] [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ParentTeamId

Set-GitHubTeam [-OrganizationName] <String> [-TeamName] <String> [-TeamSlug <String>] [-Description <String>]
 [-Privacy <String>] [-ParentTeamId <Int64>] [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Updates a team within an organization on GitHub.

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

EXAMPLES

EXAMPLE 1

Set-GitHubTeam -OrganizationName PowerShell -TeamName Developers -Description 'New Description'

Updates the description for the 'Developers' GitHub team in the 'PowerShell' organization.

EXAMPLE 2

$team = Get-GitHubTeam -OrganizationName PowerShell -TeamName Developers
$team | Set-GitHubTeam -Description 'New Description'

You can also pipe in a GitHub team that was returned from a previous command.

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

-Description

The description for the team.

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 team's organization.

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

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

-ParentTeamId

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

Type: System.Int64
Parameter Sets: ParentTeamId
Aliases:

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

-ParentTeamName

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

Type: System.String
Parameter Sets: ParentTeamName
Aliases:

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

-PassThru

Returns the updated GitHub Team. By default, this cmdlet does not generate any output. You can use "Set-GitHubConfiguration -DefaultPassThru" to control the default behavior of this switch.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Privacy

The level of privacy this team should have.

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

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

-TeamName

The name of the team.

When TeamSlug is specified, specifying a name here that is different from the existing name will cause the team to be renamed. TeamSlug and TeamName are specified for you automatically when piping in a GitHub.Team object, so a rename would only occur if intentionally specify this parameter and provide a different name.

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

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

-TeamSlug

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

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

Required: False
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.Organization

GitHub.Team

OUTPUTS

GitHub.Team

NOTES

RELATED LINKS