Skip to content

Commit b407f54

Browse files
tiburdtiburd
authored
Merge pull request MicrosoftDocs#9845 from musingh1/main
Adding the docs for CsTeamsEventsPolicy cmdlets
2 parents b69524d + 2636ebc commit b407f54

File tree

6 files changed

+716
-1
lines changed

6 files changed

+716
-1
lines changed

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

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/get-csteamseventspolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsTeamsEventsPolicy
9+
10+
## SYNOPSIS
11+
Returns information about the Teams Events policy. Note that this policy is currently still in preview.
12+
13+
## SYNTAX
14+
15+
### Identity (Default)
16+
```
17+
Get-CsTeamsEventsPolicy [[-Identity] <String>] [<CommonParameters>]
18+
```
19+
20+
### Filter
21+
```
22+
Get-CsTeamsEventsPolicy [-Filter <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
Returns information about the Teams Events policy. TeamsEventsPolicy is used to configure options for customizing Teams Events experiences.
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
```powershell
32+
PS C:\> Get-CsTeamsEventsPolicy
33+
```
34+
35+
Returns information for all Teams Events policies available for use in the tenant.
36+
37+
38+
### Example 2
39+
```powershell
40+
PS C:\> Get-CsTeamsEventsPolicy -Identity Global
41+
```
42+
43+
Returns information for Teams Events policy with identity "Global".
44+
45+
46+
## PARAMETERS
47+
48+
### -Filter
49+
Enables using wildcards when specifying the policy (or policies) to be retrieved. Note that you cannot use both the Filter and the Identity parameters in the same command.
50+
51+
```yaml
52+
Type: String
53+
Parameter Sets: Filter
54+
Aliases:
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Identity
64+
Unique identifier assigned to the Teams Events policy.
65+
66+
67+
```yaml
68+
Type: String
69+
Parameter Sets: Identity
70+
Aliases:
71+
72+
Required: False
73+
Position: 1
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
81+
82+
83+
## INPUTS
84+
85+
### None
86+
87+
## OUTPUTS
88+
89+
### System.Object
90+
## NOTES
91+
92+
## RELATED LINKS

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

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
---
2+
external help file: MicrosoftTeams-help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://docs.microsoft.com/powershell/module/teams/grant-csteamseventspolicy
5+
schema: 2.0.0
6+
---
7+
8+
# Grant-CsTeamsEventsPolicy
9+
10+
## SYNOPSIS
11+
Assigns Teams Events policy to a user, group of users, or the entire tenant. Note that this policy is currently still in preview.
12+
13+
14+
## SYNTAX
15+
16+
### Identity (Default)
17+
```
18+
Grant-CsTeamsEventsPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
19+
[-WhatIf] [-Confirm] [<CommonParameters>]
20+
```
21+
22+
### GrantToTenant
23+
```
24+
Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] <String>] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
25+
```
26+
27+
### GrantToGroup
28+
```
29+
Grant-CsTeamsEventsPolicy [-PassThru] [[-PolicyName] <String>]
30+
[-Group] <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
31+
```
32+
33+
## DESCRIPTION
34+
Assigns Teams Events policy to a user, group of users, or the entire tenant.
35+
36+
TeamsEventsPolicy is used to configure options for customizing Teams Events experiences.
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```powershell
42+
PS C:\> Grant-CsTeamsEventsPolicy -Identity "[email protected]" -Policy DisablePublicWebinars
43+
```
44+
45+
The command shown in Example 1 assigns the per-user Teams Events policy, DisablePublicWebinars, to the user with the user principal name (UPN) "[email protected]".
46+
47+
48+
### Example 2
49+
```powershell
50+
PS C:\> Grant-CsTeamsEventsPolicy -Identity "[email protected]" -Policy $null
51+
```
52+
53+
The command shown in Example 2 revokes the per-user Teams Events policy for the user with the user principal name (UPN) "[email protected]". As a result, the user will be managed by the global Teams Events policy.
54+
55+
56+
### Example 3
57+
```powershell
58+
PS C:\> Grant-CsTeamsEventsPolicy -Group "[email protected]" -Rank 10 -Policy DisablePublicWebinars
59+
```
60+
61+
The command shown in Example 3 assigns the Teams Events policy, DisablePublicWebinars, to the members of the group "[email protected]".
62+
63+
64+
## PARAMETERS
65+
66+
### -Confirm
67+
Prompts you for confirmation before running the cmdlet.
68+
69+
```yaml
70+
Type: SwitchParameter
71+
Parameter Sets: (All)
72+
Aliases: cf
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Global
82+
Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant.
83+
84+
```yaml
85+
Type: SwitchParameter
86+
Parameter Sets: GrantToTenant
87+
Aliases:
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -Group
97+
Specifies the group used for the group policy assignment.
98+
99+
```yaml
100+
Type: String
101+
Parameter Sets: GrantToGroup
102+
Aliases:
103+
104+
Required: True
105+
Position: 0
106+
Default value: None
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -Identity
112+
Specifies the identity of the target user. Acceptable values include:
113+
114+
Example: [email protected]
115+
116+
Example: sip:[email protected]
117+
118+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
119+
120+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
121+
122+
123+
```yaml
124+
Type: String
125+
Parameter Sets: Identity
126+
Aliases:
127+
128+
Required: False
129+
Position: 0
130+
Default value: None
131+
Accept pipeline input: True (ByPropertyName, ByValue)
132+
Accept wildcard characters: False
133+
```
134+
135+
### -PassThru
136+
Enables passing a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsTeamsEventsPolicy cmdlet does not pass objects through the pipeline.
137+
138+
```yaml
139+
Type: SwitchParameter
140+
Parameter Sets: (All)
141+
Aliases:
142+
143+
Required: False
144+
Position: Named
145+
Default value: None
146+
Accept pipeline input: False
147+
Accept wildcard characters: False
148+
```
149+
150+
### -PolicyName
151+
"Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:DisablePublicWebinars has a PolicyName equal to DisablePublicWebinars.
152+
153+
To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null).
154+
155+
```yaml
156+
Type: String
157+
Parameter Sets: (All)
158+
Aliases:
159+
160+
Required: False
161+
Position: 1
162+
Default value: None
163+
Accept pipeline input: False
164+
Accept wildcard characters: False
165+
```
166+
167+
### -Rank
168+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
169+
170+
```yaml
171+
Type: Int32
172+
Parameter Sets: GrantToGroup
173+
Aliases:
174+
175+
Required: False
176+
Position: Named
177+
Default value: None
178+
Accept pipeline input: False
179+
Accept wildcard characters: False
180+
```
181+
182+
### -WhatIf
183+
Shows what would happen if the cmdlet runs.
184+
The cmdlet is not run.
185+
186+
```yaml
187+
Type: SwitchParameter
188+
Parameter Sets: (All)
189+
Aliases: wi
190+
191+
Required: False
192+
Position: Named
193+
Default value: None
194+
Accept pipeline input: False
195+
Accept wildcard characters: False
196+
```
197+
198+
### CommonParameters
199+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
200+
201+
202+
## INPUTS
203+
204+
### System.String
205+
206+
## OUTPUTS
207+
208+
### System.Object
209+
## NOTES
210+
211+
## RELATED LINKS

0 commit comments

Comments
 (0)