Commands › Microsoft Teams

New-CsTeamsAppSetupPolicy

Microsoft Teams MicrosoftTeams New-*

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.

Quick start script

# New-CsTeamsAppSetupPolicy — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-MicrosoftTeams -CertificateThumbprint $thumb -ApplicationId $appId -TenantId $tenantId

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-CsTeamsAppSetupPolicy
$before | Format-List

# 3. Make the change (dry run first)
New-CsTeamsAppSetupPolicy  -WhatIf
New-CsTeamsAppSetupPolicy

# 4. Verify and diff
$after = Get-CsTeamsAppSetupPolicy
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

New-CsTeamsAppSetupPolicy [-Identity] <String>
 [-AllowSideLoading <Boolean>]
 [-AllowUserPinning <Boolean>]
 [-AppPresetList <Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPreset[]>]
 [-Confirm]
 [-Description <String>]
 [-Force]
 [-PinnedAppBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedApp[]>]
 [-PinnedCallingBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedCallingBarApp[]>]
 [-PinnedMessageBarApps <Microsoft.Teams.Policy.Administration.Cmdlets.Core.PinnedMessageBarApp[]>]
 [-AppPresetMeetingList <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AppPresetMeeting]>]
 [-AdditionalCustomizationApps <System.Management.Automation.PSListModifier`1[Microsoft.Teams.Policy.Administration.Cmdlets.Core.AdditionalCustomizationApp]>]
 [-Tenant <System.Guid>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (13)

ParameterTypeRequiredWhat it controls
-AdditionalCustomizationApps AdditionalCustomizationApp] This parameter allows IT admins to create multiple customized versions of their apps and assign these customized versions to users and groups via setup policies. It enables customization of app icons and names for...
-AllowSideLoading Boolean This is also known as side loading. This setting determines if a user can upload a custom app package in the Teams app. Turning it on lets you create or develop a custom app to be used personally or across your...
-AllowUserPinning Boolean If you turn this on, the user's existing app pins will be added to the list of pinned apps set in this policy. Users can rearrange, add, and remove pins as they choose. If you turn this off, the user's existing app...
-AppPresetList AppPreset[] Choose which apps and messaging extensions you want to be installed in your users' personal Teams environment and in meetings they create. Users can install other available apps from the Teams app store.
-AppPresetMeetingList AppPresetMeeting] This parameter is used to manage the list of preset apps that are available during meetings. It allows admins to control which apps are pinned and set the order in which they appear, ensuring that users have quick...
-Confirm SwitchParameter Prompts you for confirmation before executing the command.
-Description String Description of the app setup policy.
-Identity String Name of App setup policy. If empty, all Identities will be used by default.
-PinnedAppBarApps PinnedApp[] Pinning an app displays the app in the app bar in Teams client. Admins can pin apps and they can allow users to pin apps. Pinning is used to highlight apps that are needed the most by users and promote ease of access.
-PinnedCallingBarApps PinnedCallingBarApp[] Determines the list of apps that are pre pinned for a participant in Calls.
-PinnedMessageBarApps PinnedMessageBarApp[] Apps are pinned in messaging extensions and into the ellipsis menu.
-Tenant Guid Do not use.
-WhatIf SwitchParameter Describes what would happen if you executed the command without actually executing the command.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.