|
| 1 | +--- |
| 2 | +external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +online version: |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Grant-CsTeamsVdiPolicy |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. |
| 12 | + |
| 13 | +## SYNTAX |
| 14 | + |
| 15 | +### Identity (Default) |
| 16 | +```powershell |
| 17 | +Grant-CsTeamsVdiPolicy [<CommonParameters>] |
| 18 | +``` |
| 19 | + |
| 20 | +### GrantToUser |
| 21 | +```powershell |
| 22 | +Grant-CsTeamsVdiPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>] |
| 23 | +``` |
| 24 | + |
| 25 | +### GrantToGroup |
| 26 | +```powershell |
| 27 | +Grant-CsTeamsVdiPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32> [<CommonParameters>] |
| 28 | +``` |
| 29 | + |
| 30 | +### GrantToTenant |
| 31 | +```powershell |
| 32 | +Grant-CsTeamsVdiPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>] |
| 33 | +``` |
| 34 | + |
| 35 | +## DESCRIPTION |
| 36 | +Assigns a teams Vdi policy at the per-user scope. The CsTeamsVdiPolicy cmdlets enable administrators to control the type of meetings that users can create or the features that they can access while in a meeting specifically on an unoptimized VDI environment. It also controls whether a user can be in VDI 2.0 optimization mode. |
| 37 | + |
| 38 | +## EXAMPLES |
| 39 | + |
| 40 | +### Example 1 |
| 41 | +```powershell |
| 42 | +PS C:\> Grant-CsTeamsVdiPolicy -identity "Ken Myer" -PolicyName RestrictedUserPolicy |
| 43 | +``` |
| 44 | + |
| 45 | +In this example, a user with identity "Ken Myer" is being assigned the RestrictedUserPolicy |
| 46 | + |
| 47 | +## PARAMETERS |
| 48 | + |
| 49 | +### -Force |
| 50 | +Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
| 51 | + |
| 52 | +```yaml |
| 53 | +Type: SwitchParameter |
| 54 | +Parameter Sets: GrantToTenant |
| 55 | +Aliases: |
| 56 | + |
| 57 | +Required: False |
| 58 | +Position: Named |
| 59 | +Default value: None |
| 60 | +Accept pipeline input: False |
| 61 | +Accept wildcard characters: False |
| 62 | +``` |
| 63 | +
|
| 64 | +### -Global |
| 65 | +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". |
| 66 | +
|
| 67 | +```yaml |
| 68 | +Type: SwitchParameter |
| 69 | +Parameter Sets: GrantToTenant |
| 70 | +Aliases: |
| 71 | + |
| 72 | +Required: True |
| 73 | +Position: 0 |
| 74 | +Default value: None |
| 75 | +Accept pipeline input: False |
| 76 | +Accept wildcard characters: False |
| 77 | +``` |
| 78 | +
|
| 79 | +### -Group |
| 80 | +Specifies the group used for the group policy assignment. |
| 81 | +
|
| 82 | +```yaml |
| 83 | +Type: String |
| 84 | +Parameter Sets: GrantToGroup |
| 85 | +Aliases: |
| 86 | + |
| 87 | +Required: True |
| 88 | +Position: 0 |
| 89 | +Default value: None |
| 90 | +Accept pipeline input: False |
| 91 | +Accept wildcard characters: False |
| 92 | +``` |
| 93 | +
|
| 94 | +### -Identity |
| 95 | +Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. |
| 96 | +
|
| 97 | +```yaml |
| 98 | +Type: String |
| 99 | +Parameter Sets: GrantToUser |
| 100 | +Aliases: |
| 101 | + |
| 102 | +Required: True |
| 103 | +Position: Named |
| 104 | +Default value: None |
| 105 | +Accept pipeline input: True (ByPropertyName) |
| 106 | +Accept wildcard characters: False |
| 107 | +``` |
| 108 | +
|
| 109 | +### -PolicyName |
| 110 | +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. |
| 111 | +
|
| 112 | +```yaml |
| 113 | +Type: String |
| 114 | +Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant |
| 115 | +Aliases: |
| 116 | + |
| 117 | +Required: False |
| 118 | +Position: 1 |
| 119 | +Default value: None |
| 120 | +Accept pipeline input: False |
| 121 | +Accept wildcard characters: False |
| 122 | +``` |
| 123 | +
|
| 124 | +### -Rank |
| 125 | +The rank of the policy assignment, relative to other group policy assignments for the same policy type. |
| 126 | +
|
| 127 | +```yaml |
| 128 | +Type: Int32 |
| 129 | +Parameter Sets: GrantToGroup |
| 130 | +Aliases: |
| 131 | + |
| 132 | +Required: True |
| 133 | +Position: Named |
| 134 | +Default value: None |
| 135 | +Accept pipeline input: False |
| 136 | +Accept wildcard characters: False |
| 137 | +``` |
| 138 | +
|
| 139 | +### CommonParameters |
| 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 | +### System.String |
| 145 | +
|
| 146 | +## OUTPUTS |
| 147 | +
|
| 148 | +### System.Object |
| 149 | +## NOTES |
| 150 | +
|
| 151 | +## RELATED LINKS |
0 commit comments