Skip to content

teams tab add

Add a tab to the specified channel

Usage

m365 teams tab add [options]

Options

-i, --teamId <teamId>
The ID of the team to where the channel exists
-c, --channelId <channelId>
The ID of the channel to add a tab to
--appId <appId>
The ID of the Teams app that contains the Tab
--appName <appName>
The name of the Teams app that contains the Tab
--contentUrl <contentUrl>
The URL used for rendering Tab contents
--entityId [entityId]
A unique identifier for the Tab
--removeUrl [removeUrl]
The URL displayed when a Tab is removed
--websiteUrl [websiteUrl]
The URL for showing tab contents outside of Teams
-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv,md. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Remarks

The corresponding app must already be installed in the team.

Examples

Add teams tab for website

m365 teams tab add --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --appId 06805b9e-77e3-4b93-ac81-525eb87513b8 --appName 'My Contoso Tab' --contentUrl 'https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView'

Add teams tab for website with additional configuration which is unknown

m365 teams tab add --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --appId 06805b9e-77e3-4b93-ac81-525eb87513b8 --appName 'My Contoso Tab' --contentUrl 'https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView' --test1 'value for test1'

Response

{
  "id": "8e454194-04c9-40aa-a9f3-7ab42d9541b5",
  "displayName": "'My Contoso Tab'",
  "webUrl": "https://teams.microsoft.com/l/channel/19%3aB3nCnLKwwCoGDEADyUgQ5kJ5Pkekujyjmwxp7uhQeAE1%40thread.tacv2/tab%3a%3a8e454194-04c9-40aa-a9f3-7ab42d9541b5?label=%My/20Contoso%20Tab%27&groupId=aee5a2c9-b1df-45ac-9964-c708e760a045&tenantId=92e59666-257b-49c3-b1fa-1bae8107f6ba",
  "configuration": {
    "entityId": null,
    "contentUrl": "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView",
    "removeUrl": null,
    "websiteUrl": null
  }
}

configuration: {"entityId":null,"contentUrl":"https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView","removeUrl":null,"websiteUrl":null}
displayName  : 'My Contoso Tab'
id           : 37d2294f-6dc0-4232-8718-d388f25ee696
webUrl       : https://teams.microsoft.com/l/channel/19%3aB3nCnLKwwCoGDEADyUgQ5kJ5Pkekujyjmwxp7uhQeAE1%40thread.tacv2/tab%3a%3a37d2294f-6dc0-4232-8718-d388f25ee696?label=%My%20Contoso%20Tab%27&groupId=aee5a2c9-b1df-45ac-9964-c708e760a045&tenantId=92e59666-257b-49c3-b1fa-1bae8107f6ba

id,displayName,webUrl,configuration
0d7e343d-b233-4039-ae77-88928d4b275b,'My Contoso Tab',https://teams.microsoft.com/l/channel/19%3aB3nCnLKwwCoGDEADyUgQ5kJ5Pkekujyjmwxp7uhQeAE1%40thread.tacv2/tab%3a%3a0d7e343d-b233-4039-ae77-88928d4b275b?label=%My%20Contoso%20Tab%27&groupId=aee5a2c9-b1df-45ac-9964-c708e760a045&tenantId=92e59666-257b-49c3-b1fa-1bae8107f6ba,"{""entityId"":null,""contentUrl"":""https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView"",""removeUrl"":null,""websiteUrl"":null}"

# teams tab add --teamId "aee5a2c9-b1df-45ac-9964-c708e760a045" --channelId "19:B3nCnLKwwCoGDEADyUgQ5kJ5Pkekujyjmwxp7uhQeAE1@thread.tacv2" --appId "com.microsoft.teamspace.tab.web" --appName "My Contoso Tab" --contentUrl "https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView"

Date: 1/3/2023

## My Contoso Tab (37d2294f-6dc0-4232-8718-d388f25ee696)

Property | Value
---------|-------
id | 37d2294f-6dc0-4232-8718-d388f25ee696
displayName | My Contoso Tab
webUrl | https://teams.microsoft.com/l/channel/19%3aB3nCnLKwwCoGDEADyUgQ5kJ5Pkekujyjmwxp7uhQeAE1%40thread.tacv2/tab%3a%3a37d2294f-6dc0-4232-8718-d388f25ee696?label=%My%20Contoso%20Tab%27&groupId=aee5a2c9-b1df-45ac-9964-c708e760a045&tenantId=92e59666-257b-49c3-b1fa-1bae8107f6ba
configuration | {"entityId":null,"contentUrl":"https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView","removeUrl":null,"websiteUrl":null}