CsTeamsAppSetupPolicy
Cmdlet to set the app setup policy for Teams.
NOTE: The existence of this cmdlet is being documented for completeness, but do not use this cmdlet. We require that all creation and modification of app setup polices (not including the assignment or removal of policies from users) happens in the Microsoft Teams & Skype for Business Admin Center to ensure that the policy matches your expectations for the end user experience.
As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users. You choose the apps to pin and set the order that they appear. App setup policies let you showcase apps that users in your organization need, including ones built by third parties or by developers in your organization. You can also use app setup policies to manage how built-in features appear.
Apps are pinned to the app bar. This is the bar on the side of the Teams desktop client and at the bottom of the Teams mobile clients (iOS and Android). Learn more about the App Setup Policies: https://learn.microsoft.com/MicrosoftTeams/teams-app-setup-policies.
Available cmdlets
Parameters
| Name | Type | Default value | Accepted values |
|---|---|---|---|
| AdditionalCustomizationApps | System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp] | ||
| AllowSideLoading | Boolean | ||
| AllowUserPinning | Boolean | ||
| AppPresetList | Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[] | ||
| AppPresetMeetingList | System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting] | ||
| PinnedAppBarApps | Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[] | ||
| PinnedCallingBarApps | Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[] | ||
| PinnedMessageBarApps | Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[] |
Examples
Example 1
# Create new teams app setup policy named "Set-Test".
New-CsTeamsAppSetupPolicy -Identity 'Set-Test'
Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AllowUserPinning $true -AllowSideLoading $falseStep 1: Create a new Teams app setup policy named "Set-Test". Step 2: Set AllowUserPinning as true, AllowSideLoading as false.
Example 2
New-CsTeamsAppSetupPolicy -Identity 'Set-Test'
$ActivityApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="14d6962d-6eeb-4f48-8890-de55454bb136"}
$ChatApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="86fcd49b-61a2-4701-b771-54728cd291fb"}
$TeamsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp -Property @{Id="2a84919f-59d8-4441-a975-2a8c2643b741"}
$PinnedAppBarApps = @($ActivityApp,$ChatApp,$TeamsApp)
Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedAppBarApps $PinnedAppBarAppsStep 1: Create new teams app setup policy named "Set-Test". Step 2: Set ActivityApp, ChatApp, TeamsApp as PinnedAppBarApps. Step 3: Settings to pin these apps to the app bar in Teams client.
Example 3
New-CsTeamsAppSetupPolicy -Identity 'Set-Test'
$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"}
$PinnedMessageBarApps = @($VivaConnectionsApp)
Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -PinnedMessageBarApps $PinnedMessageBarAppsStep 1: Create new teams app setup policy named "Set-Test". Step 2: Set VivaConnectionsApp as PinnedAppBarApps. Step 3: Settings to pin these apps to the messaging extension in Teams client.
Example 4
New-CsTeamsAppSetupPolicy -Identity 'Set-Test'
$VivaConnectionsApp = New-Object -TypeName Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset -Property @{Id="d2c6f111-ffad-42a0-b65e-ee00425598aa"}
$AppPresetList = @($VivaConnectionsApp)
Set-CsTeamsAppSetupPolicy -Identity 'Set-Test' -AppPresetList $AppPresetListStep 1: Create new teams app setup policy named "Set-Test". Step 2: Set VivaConnectionsApp as AppPresetList Step 3: Settings to install these apps in your users' personal Teams environment.