|
| 1 | +--- |
| 2 | +external help file: Microsoft.Teams.PowerShell.TeamsCmdlets.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: https://docs.microsoft.com/powershell/module/teams/Update-M365TeamsApp |
| 5 | +applicable: Microsoft Teams |
| 6 | +title: Update-M365TeamsApp |
| 7 | +author: satishtimiri |
| 8 | +ms.author: satishtimiri |
| 9 | +manager: rahulrgupta |
| 10 | +schema: 2.0.0 |
| 11 | +--- |
| 12 | + |
| 13 | +# Update-M365TeamsApp |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | + |
| 17 | +This cmdlet updates app state and app available values for the Microsoft Teams app. |
| 18 | + |
| 19 | +## SYNTAX |
| 20 | + |
| 21 | +```powershell |
| 22 | +Update-M365TeamsApp -Id <String> [-IsBlocked <Boolean>] -AppAssignmentType <String> -OperationType <String> |
| 23 | + [-Users <String[]>] [-Groups <String[]>] [<CommonParameters>] |
| 24 | +``` |
| 25 | + |
| 26 | +## DESCRIPTION |
| 27 | + |
| 28 | +This cmdlet allows administrators to modify app state and availability by adding or removing users and groups or changing assignment type. |
| 29 | + |
| 30 | +## EXAMPLES |
| 31 | + |
| 32 | +### Example 1 |
| 33 | + |
| 34 | +```powershell |
| 35 | +PS C:\> Update-M365TeamsApp -Id 3acac8f6-4e9e-4ee1-9c0e-0ea837d15ea3 -IsBlocked $true -AppAssignmentType UsersAndGroups -OperationType Add -Users eec823bd-0979-4cf8-9924-85bb6ffcb57d -Groups 37da2d58-fc14-453e-9a14-5065ebd63a1d |
| 36 | +``` |
| 37 | + |
| 38 | +Updates state and availablity assignment information of 3acac8f6-4e9e-4ee1-9c0e-0ea837d15ea3 app. |
| 39 | + |
| 40 | +## PARAMETERS |
| 41 | + |
| 42 | +### -AppAssignmentType |
| 43 | + |
| 44 | +App availability type. |
| 45 | + |
| 46 | +```yaml |
| 47 | +Type: String |
| 48 | +Parameter Sets: (Everyone, UsersandGroups, Noone) |
| 49 | +Aliases: |
| 50 | + |
| 51 | +Required: True |
| 52 | +Position: Named |
| 53 | +Default value: None |
| 54 | +Accept pipeline input: False |
| 55 | +Accept wildcard characters: False |
| 56 | +``` |
| 57 | +
|
| 58 | +### -Groups |
| 59 | +
|
| 60 | +List of all the groups for whom the app is enabled or disabled. |
| 61 | +
|
| 62 | +```yaml |
| 63 | +Type: String[] |
| 64 | +Parameter Sets: (All) |
| 65 | +Aliases: |
| 66 | + |
| 67 | +Required: False |
| 68 | +Position: Named |
| 69 | +Default value: None |
| 70 | +Accept pipeline input: False |
| 71 | +Accept wildcard characters: False |
| 72 | +``` |
| 73 | +
|
| 74 | +### -Id |
| 75 | +
|
| 76 | +Application ID of Microsoft Teams app. |
| 77 | +
|
| 78 | +```yaml |
| 79 | +Type: String |
| 80 | +Parameter Sets: (All) |
| 81 | +Aliases: |
| 82 | + |
| 83 | +Required: True |
| 84 | +Position: Named |
| 85 | +Default value: None |
| 86 | +Accept pipeline input: False |
| 87 | +Accept wildcard characters: False |
| 88 | +``` |
| 89 | +
|
| 90 | +### -IsBlocked |
| 91 | +
|
| 92 | +The state of the app in the tenant. |
| 93 | +
|
| 94 | +```yaml |
| 95 | +Type: Boolean |
| 96 | +Parameter Sets: (true, false) |
| 97 | +Aliases: |
| 98 | + |
| 99 | +Required: False |
| 100 | +Position: Named |
| 101 | +Default value: None |
| 102 | +Accept pipeline input: False |
| 103 | +Accept wildcard characters: False |
| 104 | +``` |
| 105 | +
|
| 106 | +### -OperationType |
| 107 | +
|
| 108 | +Operation performed on the app assigment. |
| 109 | +
|
| 110 | +```yaml |
| 111 | +Type: String |
| 112 | +Parameter Sets: (Add, Remove) |
| 113 | +Aliases: |
| 114 | + |
| 115 | +Required: True |
| 116 | +Position: Named |
| 117 | +Default value: None |
| 118 | +Accept pipeline input: False |
| 119 | +Accept wildcard characters: False |
| 120 | +``` |
| 121 | +
|
| 122 | +### -Users |
| 123 | +
|
| 124 | +List of all the users for whom the app is enabled or disabled. |
| 125 | +
|
| 126 | +```yaml |
| 127 | +Type: String[] |
| 128 | +Parameter Sets: (All) |
| 129 | +Aliases: |
| 130 | + |
| 131 | +Required: False |
| 132 | +Position: Named |
| 133 | +Default value: None |
| 134 | +Accept pipeline input: False |
| 135 | +Accept wildcard characters: False |
| 136 | +``` |
| 137 | +
|
| 138 | +### CommonParameters |
| 139 | +
|
| 140 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 141 | +
|
| 142 | +## INPUTS |
| 143 | +
|
| 144 | +### None |
| 145 | +
|
| 146 | +## OUTPUTS |
| 147 | +
|
| 148 | +### System.Object |
| 149 | +
|
| 150 | +## RELATED LINKS |
| 151 | +
|
| 152 | +[Get-M365TeamsApps](/powershell/module/teams/get-m365teamsapps) |
| 153 | +
|
| 154 | +[Get-ALLM365TeamsApps](/powershell/module/teams/Get-ALLM365TeamsApps) |
0 commit comments