Grant-CsTeamsAppSetupPolicy

Reference

Module:: MicrosoftTeamsPowerShell

Applies to:: Microsoft Teams

NOTE: You can use this cmdlet to assign a specific custom policy to a user. 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: /MicrosoftTeams/teams-app-setup-policies.

Syntax

Grant-CsTeamsAppSetupPolicy []

Grant-CsTeamsAppSetupPolicy
     [-Identity] <String>
     [[-PolicyName] <String>]
     [<CommonParameters>]

Grant-CsTeamsAppSetupPolicy
     [[-PolicyName] <String>]
     [-Group] <String>
     [-Rank] <Int32>
     [<CommonParameters>]

Grant-CsTeamsAppSetupPolicy
     [[-PolicyName] <String>]
     [-Global]
     [-Force]
     [<CommonParameters>]

Description

Examples

Example 1

PS C:\> Grant-CsTeamsAppSetupPolicy -identity "Ken Myer" -PolicyName StudentAppSetupPolicy

In this example, a user with identity "Ken Myer" is being assigned the StudentAppSetupPolicy

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainController

Do not use.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Global

Resets the values in the global policy to match those in the provided (PolicyName) policy. Note that this means all users with no explicit policy assigned will have these new policy settings.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Group

Specifies the group used for the group policy assignment.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Identity

The user to whom the policy should be assigned.

Type:	UserIdParameter
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PolicyName

The name of the custom policy that is being assigned to the user. To remove a specific assignment and fall back to the default tenant policy, you can assign to $Null.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Rank

The rank of the policy assignment, relative to other group policy assignments for the same policy type.

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenant