teamsTab resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A teamsTab is a tab that's pinned (attached) to a channel within a team.

Methods

Method Return Type Description
List tabs teamsTab Lists tabs pinned to a channel.
Get tab teamsTab Reads a tab pinned to a channel.
Add tab teamsTab Adds (pins) a tab to a channel.
Delete tab None Removes (unpins) a tab from a channel.
Update tab teamsTab Updates the tab properties.

Properties

Property Type Description
id string Identifier that uniquely identifies a specific instance of a channel tab. Read only.
displayName string Name of the tab.
name (deprecated) string Name of the tab.
teamsAppId (deprecated) string App definition identifier of the tab. This value cannot be changed after tab creation. Because this property is deprecated, we recommend expanding teamsApp to retrieve the application that is linked to the tab.
sortOrderIndex string Index of the order used for sorting tabs.
webUrl string Deep link URL of the tab instance. Read only.
configuration teamsTabConfiguration Container for custom settings applied to a tab. The tab is considered configured only once this property is set.

Relationships

Relationship Type Description
teamsApp teamsApp The application that is linked to the tab.

JSON representation

The following is a JSON representation of the resource.

{
  "id": "string",
  "displayName": "string",
  "teamsAppId": "string",
  "sortOrderIndex": "string",
  "webUrl": "string",
  "configuration": "teamsTabConfiguration",
  "name": "string"
}

See also

Configuring the built-in tab types