TeamTabs

Documents tabs added to Teams channels, including tab type (Planner, Website, custom app) and configuration data.

Table Specific Information

Select

To query the TeamTabs table you need to specify TeamId and ChannelId filters in order to retreive tabs for the specified channel which belongs to the specified team. The component will use the Microsoft Teams API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the component.

TeamId and ChannelId support the '=' and IN operators. All the other columns support the '=', IN, LIKE, !=, IS, IS NOT operators.

For example, the following queries are processed server side:

SELECT * FROM TeamTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]'
SELECT * FROM TeamTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND Id LIKE '%-ade1-400a-a82b-e7a435199b7a'
SELECT * FROM TeamTabs WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5' AND ChannelId IN (SELECT Id FROM Channels WHERE TeamId = '12d95e4d-f90f-434c-b280-dd7f8b8615e5') AND configuration_entityId IS NOT NULL

Insert

At least TeamId, ChannelId and AppID are required to insert a new tab in a channel. You can specify any other field as well.

INSERT INTO TeamTabs (TeamId, ChannelId, DisplayName, AppID) VALUES ('4729c5e5-f923-4435-8a41-44423d42ea79', '19:[email protected]', 'new tab for test', '0d820ecd-def2-4297-adad-78056cde7c78')

Update

To update a tab record you need to specify the Id, ChannelId and TeamId in the WHERE clause.

UPDATE TeamTabs SET DisplayName = 'updatetabname' WHERE Id = 'c41cbfe0-7713-44d6-96dd-b692569f1766' AND ChannelId = '19:[email protected]' AND TeamId = '4729c5e5-f923-4435-8a41-44423d42ea79'

Delete

To delete a tab record you need to specify the Id, ChannelId and TeamId in the WHERE clause.

DELETE FROM TeamTabs WHERE TeamId = 'da838338-4e77-4c05-82a6-79d9f0274511' AND ChannelId = '19:[email protected]' AND Id = '16ba49df-d7e1-4dc7-b6c3-ea721d327d38'

Columns


Name	Type	ReadOnly	Description
id [KEY]	String	False	A unique identifier for the specific tab instance within a channel.
AppId	String	False	The identifier of the app associated with the tab.
ChannelId	String	False	The identifier of the channel where the tab is located.
Configuration_contentUrl	String	False	The URL used by Teams to render the tab content inside the Teams client. This is required for the tab to function.
Configuration_entityId	String	False	A custom identifier for the entity represented by the tab, used by the app to load specific data or context.
Configuration_removeUrl	String	False	The callback URL invoked by the Teams client when a tab is removed. Used for cleanup or telemetry.
Configuration_websiteUrl	String	False	A publicly accessible URL used to view the tab's contents outside of Microsoft Teams.
DisplayName	String	False	The display name of the tab, shown in the channel tab navigation.
WebUrl	String	False	A deep link URL that opens the tab instance directly in the Teams client.
TeamsApp_id	String	True	The unique identifier for the Teams app definition used by the tab.
TeamId	String	False	The identifier of the Team that contains the tab and its associated channel.