Channels
Channels table for MSTeams data provider.
Table Specific Information
Select
Query the Channels table by retrieving all channels in all teams or by specifying TeamId. The cmdlet uses the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators:
- TeamId supports the '=' and IN operators. The rest of the columns support the '=', '!=', IN, LIKE, IS, IS NOT operator.
The rest of the filter is executed client side within the cmdlet
For example, the following queries are processed server side:
SELECT * FROM Channels WHERE TeamId IN ('da838338-4e77-4c05-82a6-79d9f0274511', 'da838338-4e77-4c05-82a6-79d9f0274555') SELECT * FROM Channels WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND Id = '19:[email protected]' SELECT * FROM Channels WHERE description != 'desc' SELECT * FROM Channels WHERE webUrl LIKE '%teams.microsoft.com/l/channel/%'Note: the summary columns are only populated when the table is filtered with the Id column. Additionally, there is no filtering allowed with the summary columns for this table.
Insert
At least TeamId and DisplayName are required to insert a new channel to a team. You can specify any other field as well.
INSERT INTO Channels (displayName, description, TeamId) VALUES ('a new channel', 'top tasks channel', 'da838338-4e77-4c05-82a6-79d9f0274511')
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
The channel's unique identifier. |
TeamId | String | False |
The Team Id. |
CreatedDateTime | Datetime | False |
Timestamp at which the channel was created. |
Description | String | False |
Optional textual description for the channel. |
DisplayName | String | False |
Channel name as it will appear to the user in Microsoft Teams. |
String | False |
The email address for sending messages to the channel. Read-only. | |
IsFavoriteByDefault | Bool | False |
Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: false. |
MembershipType | String | False |
The type of the channel. Can be set during creation and cannot be changed. Default: standard. |
WebUrl | String | False |
A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. |