Commands › Microsoft Teams

Grant-CsTeamsAppSetupPolicy

Microsoft Teams MicrosoftTeams Grant-*

As an admin, you can use app setup policies to customize Microsoft Teams to highlight the apps that are most important for your users.

Quick start script

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

# 2. Run and inspect
Grant-CsTeamsAppSetupPolicy -Group <String> -PolicyName <String> -Rank <Int32> | Format-List

# 3. Export for evidence / drift tracking
Grant-CsTeamsAppSetupPolicy | Export-Clixml .\CsTeamsAppSetupPolicy-$(Get-Date -Format yyyyMMdd).xml

Syntax — 4 parameter sets

Identity (Default)

Grant-CsTeamsAppSetupPolicy [<CommonParameters>]

GrantToUser

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

GrantToGroup

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

GrantToTenant

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

Parameters (10)

ParameterTypeRequiredWhat it controls
-Confirm SwitchParameter Prompts you for confirmation before running the cmdlet.
-DomainController Fqdn Do not use.
-Global SwitchParameter 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.
-Group String yes Specifies the group used for the group policy assignment.
-Identity UserIdParameter The user to whom the policy should be assigned.
-PassThru SwitchParameter {{ Fill PassThru Description }}
-PolicyName String yes 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.
-Rank Int32 yes The rank of the policy assignment, relative to other group policy assignments for the same policy type.
-Tenant Guid Do not use.
-WhatIf SwitchParameter Shows what would happen if the cmdlet runs. The cmdlet is not run.

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