Skip to content

Commit fac2f92

Browse files
tiburdtiburd
authored
Merge pull request #11222 from emmanuelrocha001/main
Add TeamsVirtualAppointmentsPolicy cmdlet docs
2 parents 5c3c679 + 53f41c3 commit fac2f92

5 files changed

+718
-0
lines changed

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

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsvirtualappointmentspolicy
5+
schema: 2.0.0
6+
ms.author: erocha
7+
manager: sonaggarwal
8+
author: emmanuelrocha001
9+
---
10+
11+
# Get-CsTeamsVirtualAppointmentsPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet is used to fetch policy instances of TeamsVirtualAppointmentsPolicy.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
Get-CsTeamsVirtualAppointmentsPolicy [[-Identity] <String>] [<CommonParameters>]
21+
```
22+
23+
### Filter
24+
```
25+
Get-CsTeamsVirtualAppointmentsPolicy [-Filter <String>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
Fetches instances of TeamsVirtualAppointmentsPolicy. Each policy object contains a property called `EnableSmsNotifications`. This property specifies whether your users can choose to send SMS text notifications to external guests in meetings that they schedule using a virtual appointment meeting template.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
PS C:\> Get-CsTeamsVirtualAppointmentsPolicy
36+
```
37+
```output
38+
Identity EnableSmsNotifications
39+
-------- ----------------------
40+
Global True
41+
Tag:sms-enabled True
42+
Tag:sms-disabled False
43+
```
44+
Fetches all the policy instances currently available.
45+
46+
### Example 2
47+
```powershell
48+
PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Identity sms-enabled
49+
```
50+
```output
51+
Identity EnableSmsNotifications
52+
-------- ----------------------
53+
Tag:sms-enabled True
54+
```
55+
Fetches an instance of a policy with a known identity.
56+
57+
### Example 3
58+
```powershell
59+
PS C:\> Get-CsTeamsVirtualAppointmentsPolicy -Filter *sms*
60+
```
61+
```output
62+
Identity EnableSmsNotifications
63+
-------- ----------------------
64+
Tag:sms-enabled True
65+
Tag:sms-disabled False
66+
```
67+
The `Filter` parameter can be used to fetch policy instances based on partial matches on Identity.
68+
69+
Note: _The "Tag:" prefix can be ignored when specifying the identity._
70+
71+
## PARAMETERS
72+
73+
### -Filter
74+
This parameter can be used to fetch policy instances based on partial matches on the Identity field.
75+
76+
```yaml
77+
Type: String
78+
Parameter Sets: Filter
79+
Aliases:
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### -Identity
89+
This parameter can be used to fetch a specific instance of the policy.
90+
91+
```yaml
92+
Type: String
93+
Parameter Sets: Identity
94+
Aliases:
95+
96+
Required: False
97+
Position: 1
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### CommonParameters
104+
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).
105+
106+
## INPUTS
107+
108+
### System.String
109+
110+
## OUTPUTS
111+
112+
### TeamsVirtualAppointmentsPolicy.Cmdlets.TeamsVirtualAppointmentsPolicy
113+
114+
## NOTES
115+
116+
## RELATED LINKS
117+
[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md)
118+
119+
[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md)
120+
121+
[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md)
122+
123+
[Grant-CsTeamsVirtualAppointmentsPolicy](Grant-CsTeamsVirtualAppointmentsPolicy.md)

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

Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
---
2+
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
3+
Module Name: MicrosoftTeams
4+
online version: https://learn.microsoft.com/powershell/module/teams/grant-csteamsvirtualappointmentspolicy
5+
schema: 2.0.0
6+
ms.author: erocha
7+
manager: sonaggarwal
8+
author: emmanuelrocha001
9+
---
10+
11+
# Grant-CsTeamsVirtualAppointmentsPolicy
12+
13+
## SYNOPSIS
14+
This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant.
15+
16+
## SYNTAX
17+
18+
### Identity (Default)
19+
```
20+
Grant-CsTeamsVirtualAppointmentsPolicy [<CommonParameters>]
21+
```
22+
23+
### GrantToUser
24+
```
25+
Grant-CsTeamsVirtualAppointmentsPolicy -Identity <String> [[-PolicyName] <String>] [<CommonParameters>]
26+
```
27+
28+
### GrantToGroup
29+
```
30+
Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] <String>] [-Group] <String> -Rank <Int32>
31+
[<CommonParameters>]
32+
```
33+
34+
### GrantToTenant
35+
```
36+
Grant-CsTeamsVirtualAppointmentsPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
37+
```
38+
39+
## DESCRIPTION
40+
41+
This cmdlet applies an instance of the TeamsVirtualAppointmentsPolicy to users or groups in a tenant.
42+
43+
Passes in the `Identity` of the policy instance in the `PolicyName` parameter and the user identifier in the `Identity` parameter or the group name in the `Group` parameter. One of either `Identity` or `Group` needs to be passed.
44+
45+
46+
## EXAMPLES
47+
48+
### Example 1
49+
```powershell
50+
PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -PolicyName sms-enabled -Identity [email protected]
51+
```
52+
53+
Assigns a given policy to a user.
54+
55+
### Example 2
56+
```powershell
57+
PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Group f13d6c9d-ce76-422c-af78-b6018b4d9c80 -PolicyName sms-enabled
58+
```
59+
60+
Assigns a given policy to a group.
61+
62+
63+
### Example 3
64+
```powershell
65+
PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled
66+
```
67+
68+
Assigns a given policy to the tenant.
69+
70+
### Example 3
71+
```powershell
72+
PS C:\> Grant-CsTeamsVirtualAppointmentsPolicy -Global -PolicyName sms-enabled
73+
```
74+
75+
Note: _Using $null in place of a policy name can be used to unassigned a policy instance._
76+
77+
## PARAMETERS
78+
79+
### -Force
80+
Suppresses the display of any non-fatal error message that might arise when running the command.
81+
82+
```yaml
83+
Type: SwitchParameter
84+
Parameter Sets: GrantToTenant
85+
Aliases:
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### -Global
95+
This is the equivalent to `-Identity Global`.
96+
97+
```yaml
98+
Type: SwitchParameter
99+
Parameter Sets: GrantToTenant
100+
Aliases:
101+
102+
Required: True
103+
Position: 0
104+
Default value: None
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### -Group
110+
This is the identifier of the group that the policy should be assigned to.
111+
112+
```yaml
113+
Type: String
114+
Parameter Sets: GrantToGroup
115+
Aliases:
116+
117+
Required: True
118+
Position: 0
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -Identity
125+
Specifies the identity of the target user.
126+
127+
Example: [email protected]
128+
129+
Example: 98403f08-577c-46dd-851a-f0460a13b03d
130+
131+
Use the "Global" Identity if you wish to set the policy for the entire tenant.
132+
133+
```yaml
134+
Type: String
135+
Parameter Sets: GrantToUser
136+
Aliases:
137+
138+
Required: True
139+
Position: Named
140+
Default value: None
141+
Accept pipeline input: False
142+
Accept wildcard characters: False
143+
```
144+
145+
### -PolicyName
146+
Specifies the name of the policy to be assigned. The PolicyName is the policy identity minus the policy scope ("tag:"), for example, a policy that has an identity of "Tag:Enabled" has a PolicyName of "Enabled".
147+
148+
```yaml
149+
Type: String
150+
Parameter Sets: GrantToUser, GrantToGroup, GrantToTenant
151+
Aliases:
152+
153+
Required: False
154+
Position: 1
155+
Default value: None
156+
Accept pipeline input: False
157+
Accept wildcard characters: False
158+
```
159+
160+
### -Rank
161+
The rank of the policy assignment, relative to other group policy assignments for the same policy type.
162+
163+
```yaml
164+
Type: Int32
165+
Parameter Sets: GrantToGroup
166+
Aliases:
167+
168+
Required: True
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```
174+
175+
### CommonParameters
176+
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).
177+
178+
## INPUTS
179+
180+
### System.String
181+
182+
## OUTPUTS
183+
184+
### System.Void
185+
186+
## NOTES
187+
188+
## RELATED LINKS
189+
[Get-CsTeamsVirtualAppointmentsPolicy](Get-CsTeamsVirtualAppointmentsPolicy.md)
190+
191+
[New-CsTeamsVirtualAppointmentsPolicy](New-CsTeamsVirtualAppointmentsPolicy.md)
192+
193+
[Set-CsTeamsVirtualAppointmentsPolicy](Set-CsTeamsVirtualAppointmentsPolicy.md)
194+
195+
[Remove-CsTeamsVirtualAppointmentsPolicy](Remove-CsTeamsVirtualAppointmentsPolicy.md)
196+

0 commit comments

Comments
 (0)