Set-PnPTeamsChannel

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Set-PnPTeamsChannel.md to change this file.

Required Permissions

  • Microsoft Graph API: Group.ReadWrite.All

Updates an existing Teams Channel

Syntax

Set-PnPTeamsChannel
   -Team <TeamsTeamPipeBind>
   -Identity <TeamsChannelPipeBind>
   [-DisplayName <String>]
   [-Description <String>]
   [-IsFavoriteByDefault <Boolean>] 
   [<CommonParameters>]

Examples

EXAMPLE 1

Set-PnPTeamsChannel -Team "MyTeam" -Channel "MyChannel" -DisplayName "My Channel"

Updates the channel called 'MyChannel' to have the display name set to 'My Channel'

EXAMPLE 2

Set-PnPTeamsChannel -Team "MyTeam" -Channel "MyChannel" -IsFavoriteByDefault $true

Updates the channel called 'MyChannel' to make it visible to members.

Parameters

-Description

Changes the description of the specified channel.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisplayName

Changes the display name of the specified channel.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Identity

Specify the channel id or display name of the channel to use.

Type:TeamsChannelPipeBind
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-IsFavoriteByDefault

Allows you to specify if the channel is by default visible for members

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Team

Specify the group id, mailNickname or display name of the team to use.

Type:TeamsTeamPipeBind
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False