Skip to content

Commit e950a4b

Browse files
American-DipperAmerican-Dipper
authored
Merge branch 'main' into patch-9
2 parents 6a916ff + 942735d commit e950a4b

File tree

6 files changed

+692
-0
lines changed

6 files changed

+692
-0
lines changed

‎teams/teams-ps/teams/Get-CsTeamsVdiPolicy.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
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+
# Get-CsTeamsVdiPolicy
9+
10+
## SYNOPSIS
11+
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+
Get-CsTeamsVdiPolicy [[-Identity] <String>] [<CommonParameters>]
18+
```
19+
20+
### Filter
21+
```powershell
22+
Get-CsTeamsVdiPolicy [-Filter <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
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.
27+
28+
Teams Vdi policies can be configured at the global and per-user scopes. The Get-CsTeamsVdiPolicy cmdlet enables you to return infomration about all the Vdi policies that have been configured for use in your organization.
29+
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Get-CsTeamsVdiPolicy
36+
```
37+
38+
In Example 1, Get-CsTeamsVdiPolicy is called without any additional parameters; this returns a collection of all the teams meeting policies configured for use in your organization.
39+
40+
41+
### Example 2
42+
```powershell
43+
PS C:\> Get-CsTeamsVdiPolicy -Identity SalesPolicy
44+
```
45+
46+
In Example 2, Get-CsTeamsVdiPolicy is used to return the per-user meeting policy that has an Identity SalesPolicy. Because identites are unique, this command will never return more than one item.
47+
48+
### Example 3
49+
```powershell
50+
PS C:\> Get-CsTeamsVdiPolicy | where-Object {$_.VDI2Optimization -eq "Enabled"}
51+
```
52+
53+
The preceding command returns a collection of all the meeting policies where the VDI2Optimization property is Enabled. To do this, Get-CsTeamsVdiPolicy is first called without any parameters in order to return a collection of all the policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the VDI2Optimization property is equal to Enabled.
54+
55+
56+
## PARAMETERS
57+
58+
### -Filter
59+
Enables you to use wildcard characters when indicating the policy (or policies) to be returned.
60+
61+
```yaml
62+
Type: String
63+
Parameter Sets: Filter
64+
Aliases:
65+
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -Identity
74+
Unique identifier of the policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a per-user policy, use syntax similar to this: -Identity SalesDepartmentPolicy. If this parameter is omitted, then all the meeting policies configured for use in your organization will be returned.
75+
76+
```yaml
77+
Type: String
78+
Parameter Sets: Identity
79+
Aliases:
80+
81+
Required: False
82+
Position: 1
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### CommonParameters
89+
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).
90+
91+
## INPUTS
92+
93+
### None
94+
95+
## OUTPUTS
96+
97+
### TeamsVdiPolicy.Cmdlets.TeamsVdiPolicy
98+
99+
## NOTES
100+
101+
## RELATED LINKS

‎teams/teams-ps/teams/Grant-CsTeamsVdiPolicy.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
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

Comments
 (0)