TeamsChannelTab

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
DisplayName	Key	String	Display Name of the Channel Tab.
TeamName	Key	String	Display Name of the Team.
ChannelName	Key	String	Display Name of the Channel.
TeamId	Write	String	Unique Id of the Team of the instance on the source tenant.
TeamsApp	Write	String	Id of the Teams App associated with the custom tab.
SortOrderIndex	Write	String	Index of the sort order for the custom tab.
Configuration	Write	MSFT_MicrosoftGraphTeamsTabConfiguration	Container for custom settings applied to a tab.
Ensure	Write	String	Present ensures the Tab exists, absent ensures it is removed.	Present, Absent
Credential	Write	PSCredential	Credentials of the Teams Admin
ApplicationId	Write	String	Id of the Azure Active Directory application to authenticate with.
TenantId	Write	String	Id of the Azure Active Directory tenant used for authentication.
CertificateThumbprint	Write	String	Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication.
CertificatePassword	Write	PSCredential	Username can be made up to anything but password will be used for CertificatePassword
CertificatePath	Write	String	Path to certificate used in service principal usually a PFX file.
ManagedIdentity	Write	Boolean	Managed ID being used for authentication.
AccessTokens	Write	String[]	Access token used for authentication.

Embedded Instances

MSFT_MicrosoftGraphTeamsTabConfiguration

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
ContentUrl	Write	String	Url used for rendering tab contents in Teams.
EntityId	Write	String	Identifier for the entity hosted by the tab provider.
RemoveUrl	Write	String	Url called by Teams client when a Tab is removed using the Teams client.
WebsiteUrl	Write	String	Url for showing tab contents outside of Teams.

Description

This resource configures a new Custom tab in a Channel.

Permissions

Graph

To authenticate with the Graph API, this resource requires the following permissions:

Delegated permissions

• Read

• ChannelSettings.Read.All, GroupMember.Read.All

• Update

• Channel.Delete.All, ChannelSettings.Read.All, TeamsTab.Create, TeamsTab.ReadWrite.All, GroupMember.Read.All

Application permissions

• Read

• ChannelSettings.Read.All, GroupMember.Read.All

• Update

• Channel.Delete.All, ChannelSettings.Read.All, TeamsTab.Create, TeamsTab.ReadWrite.All, GroupMember.Read.All

Examples

Example 1

This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.

Configuration Example
{
    param
    (
        [Parameter()]
        [System.String]
        $ApplicationId,

        [Parameter()]
        [System.String]
        $TenantId,

        [Parameter()]
        [System.String]
        $CertificateThumbprint
    )

    Import-DscResource -ModuleName Microsoft365DSC

    Node localhost
    {
        TeamsChannelTab 'TeamsChannelTab-Example'
        {
            ChannelName           = "General"
            Configuration         = MSFT_MicrosoftGraphTeamsTabConfiguration{
                ContentUrl = "https://contoso.com"
                WebsiteUrl = "https://contoso.com"
            }
            DisplayName           = "Project Plan"
            SortOrderIndex        = "10100"
            TeamName              = "Contoso Team"
            TeamsApp              = "com.microsoft.teamspace.tab.web"
            Ensure                = "Present"
            ApplicationId         = $ApplicationId
            TenantId              = $TenantId
            CertificateThumbprint = $CertificateThumbprint
        }
    }
}