Skip to content

Commit 25c1325

Browse files
authored
Merge pull request #11960 from michbrown-png/main
Updating Parameters for 7 Grant Cmdlets
2 parents 2235ee9 + d1efdd5 commit 25c1325

7 files changed

+43
-265
lines changed

teams/teams-ps/teams/Grant-CsExternalAccessPolicy.md

Lines changed: 10 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ This cmdlet was introduced in Lync Server 2010.
2222
## SYNTAX
2323

2424
### Identity (Default)
25-
```
25+
```powershell
2626
Grant-CsExternalAccessPolicy [<CommonParameters>]
2727
```
2828

2929
### GrantToUser
30-
```
30+
```powershell
3131
Grant-CsExternalAccessPolicy [-Identity] <String> [[-PolicyName] <String>] [<CommonParameters>]
3232
```
3333

3434
### GrantToGroup
35-
```
35+
```powershell
3636
Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Group] <String> [-Rank] <Int32> [<CommonParameters>]
3737
```
3838

3939
### GrantToTenant
40-
```
40+
```powershell
4141
Grant-CsExternalAccessPolicy [[-PolicyName] <String>] [-Global] [-Force] [<CommonParameters>]
4242
```
4343

@@ -78,14 +78,14 @@ That's because the settings in the per-user policy take precedence.
7878
## EXAMPLES
7979

8080
### -------------------------- EXAMPLE 1 --------------------------
81-
```
81+
```powershell
8282
Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolicy
8383
```
8484

8585
Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer.
8686

8787
### -------------------------- EXAMPLE 2 --------------------------
88-
```
88+
```powershell
8989
Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy
9090
```
9191

@@ -94,7 +94,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter para
9494
That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection.
9595

9696
### -------------------------- EXAMPLE 3 --------------------------
97-
```
97+
```powershell
9898
Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy
9999
```
100100

@@ -103,7 +103,7 @@ To perform this task, the command first uses the Get-CsUser cmdlet and the LdapF
103103
This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection.
104104

105105
### -------------------------- EXAMPLE 4 --------------------------
106-
```
106+
```powershell
107107
Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy
108108
```
109109

@@ -112,7 +112,7 @@ The command shown in Example 4 assigns the external access policy BasicAccessPol
112112
By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy.
113113

114114
### -------------------------- EXAMPLE 5 --------------------------
115-
```
115+
```powershell
116116
Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy
117117
```
118118

@@ -121,7 +121,7 @@ The command starts off by calling the Get-CsUser cmdlet and the OU parameter; th
121121
The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection.
122122

123123
### -------------------------- EXAMPLE 6 --------------------------
124-
```
124+
```powershell
125125
Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null
126126
```
127127

@@ -206,38 +206,6 @@ Accept pipeline input: False
206206
Accept wildcard characters: False
207207
```
208208
209-
### -WhatIf
210-
Describes what would happen if you executed the command without actually executing the command.
211-
212-
```yaml
213-
Type: SwitchParameter
214-
Parameter Sets: (All)
215-
Aliases: wi
216-
Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019
217-
218-
Required: False
219-
Position: Named
220-
Default value: None
221-
Accept pipeline input: False
222-
Accept wildcard characters: False
223-
```
224-
225-
### -Confirm
226-
Prompts you for confirmation before executing the command.
227-
228-
```yaml
229-
Type: SwitchParameter
230-
Parameter Sets: (All)
231-
Aliases: cf
232-
Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019
233-
234-
Required: False
235-
Position: Named
236-
Default value: None
237-
Accept pipeline input: False
238-
Accept wildcard characters: False
239-
```
240-
241209
### -Tenant
242210
This parameter is reserved for internal Microsoft use.
243211

teams/teams-ps/teams/Grant-CsOnlineVoiceRoutingPolicy.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ Assigns a per-user online voice routing policy to one user, a group of users, or
1818
## SYNTAX
1919

2020
### Identity (Default)
21-
```
22-
Grant-CsOnlineVoiceRoutingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```powershell
22+
Grant-CsOnlineVoiceRoutingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [<CommonParameters>]
2323
```
2424

2525
### GrantToTenant
26-
```
27-
Grant-CsOnlineVoiceRoutingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
26+
```powershell
27+
Grant-CsOnlineVoiceRoutingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [<CommonParameters>]
2828
```
2929

3030
### GrantToGroup
31-
```
32-
Grant-CsOnlineVoiceRoutingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>]
31+
```powershell
32+
Grant-CsOnlineVoiceRoutingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [<CommonParameters>]
3333
```
3434

3535
## DESCRIPTION
@@ -168,37 +168,6 @@ Accept pipeline input: False
168168
Accept wildcard characters: False
169169
```
170170

171-
### -WhatIf
172-
Shows what would happen if the cmdlet runs.
173-
The cmdlet is not run.
174-
175-
```yaml
176-
Type: SwitchParameter
177-
Parameter Sets: (All)
178-
Aliases: wi
179-
180-
Required: False
181-
Position: Named
182-
Default value: None
183-
Accept pipeline input: False
184-
Accept wildcard characters: False
185-
```
186-
187-
### -Confirm
188-
Prompts you for confirmation before running the cmdlet.
189-
190-
```yaml
191-
Type: SwitchParameter
192-
Parameter Sets: (All)
193-
Aliases: cf
194-
195-
Required: False
196-
Position: Named
197-
Default value: None
198-
Accept pipeline input: False
199-
Accept wildcard characters: False
200-
```
201-
202171
### CommonParameters
203172
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).
204173

teams/teams-ps/teams/Grant-CsTeamsCallingPolicy.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ Assigns a specific Teams Calling Policy to a user, a group of users, or sets the
2020
## SYNTAX
2121

2222
### Identity (Default)
23-
```
24-
Grant-CsTeamsCallingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
23+
```powershell
24+
Grant-CsTeamsCallingPolicy [[-Identity] <string>] [[-PolicyName] <string>] [-PassThru] [<CommonParameters>]
2525
```
2626

2727
### GrantToTenant
28-
```
29-
Grant-CsTeamsCallingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
```powershell
29+
Grant-CsTeamsCallingPolicy [[-PolicyName] <string>] [-PassThru] [-Global] [<CommonParameters>]
3030
```
3131

3232
### GrantToGroup
33-
```
34-
Grant-CsTeamsCallingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [-WhatIf] [-Confirm] [<CommonParameters>]
33+
```powershell
34+
Grant-CsTeamsCallingPolicy [-Group] <string> [[-PolicyName] <string>] [-PassThru] [-Rank <int>] [<CommonParameters>]
3535
```
3636

3737
## DESCRIPTION
@@ -153,37 +153,6 @@ Accept pipeline input: False
153153
Accept wildcard characters: False
154154
```
155155
156-
### -WhatIf
157-
Shows what would happen if the cmdlet runs.
158-
The cmdlet is not run.
159-
160-
```yaml
161-
Type: SwitchParameter
162-
Parameter Sets: (All)
163-
Aliases: wi
164-
165-
Required: False
166-
Position: Named
167-
Default value: None
168-
Accept pipeline input: False
169-
Accept wildcard characters: False
170-
```
171-
172-
### -Confirm
173-
Prompts you for confirmation before running the cmdlet.
174-
175-
```yaml
176-
Type: SwitchParameter
177-
Parameter Sets: (All)
178-
Aliases: cf
179-
180-
Required: False
181-
Position: Named
182-
Default value: None
183-
Accept pipeline input: False
184-
Accept wildcard characters: False
185-
```
186-
187156
### CommonParameters
188157
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).
189158

teams/teams-ps/teams/Grant-CsTeamsMeetingPolicy.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,20 @@ Assigns a teams meeting policy at the per-user scope. The CsTeamsMeetingPolicy c
1919
## SYNTAX
2020

2121
### GrantToTenant (Default)
22-
```
23-
Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] <String>]
24-
[-WhatIf] [-Confirm] [<CommonParameters>]
22+
```powershell
23+
Grant-CsTeamsMeetingPolicy [-Global] [-PassThru] [[-PolicyName] <String>] [<CommonParameters>]
2524
```
2625

2726
### GrantToGroup
28-
```
27+
```powershell
2928
Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] <String>]
30-
-Group <String> [-Rank <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
29+
[[-Group] <String>] [-Rank <Int32>] [<CommonParameters>]
3130
```
3231

3332
### Identity
34-
```
33+
```powershell
3534
Grant-CsTeamsMeetingPolicy [-PassThru] [[-PolicyName] <String>]
36-
[[-Identity] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
35+
[[-Identity] <String>] [<CommonParameters>]
3736
```
3837

3938
## DESCRIPTION
@@ -50,22 +49,6 @@ In this example, a user with identity "Ken Myer" is being assigned the StudentMe
5049

5150
## PARAMETERS
5251

53-
### -Confirm
54-
Prompts you for confirmation before running the cmdlet.
55-
56-
```yaml
57-
Type: SwitchParameter
58-
Parameter Sets: (All)
59-
Aliases: cf
60-
applicable: Microsoft Teams
61-
62-
Required: False
63-
Position: Named
64-
Default value: None
65-
Accept pipeline input: False
66-
Accept wildcard characters: False
67-
```
68-
6952
### -DomainController
7053

7154
```yaml
@@ -188,22 +171,6 @@ Accept pipeline input: False
188171
Accept wildcard characters: False
189172
```
190173
191-
### -WhatIf
192-
Shows what would happen if the cmdlet runs.
193-
The cmdlet is not run.
194-
195-
```yaml
196-
Type: SwitchParameter
197-
Parameter Sets: (All)
198-
Aliases: wi
199-
applicable: Microsoft Teams
200-
201-
Required: False
202-
Position: Named
203-
Default value: None
204-
Accept pipeline input: False
205-
Accept wildcard characters: False
206-
```
207174
208175
### CommonParameters
209176
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).`

teams/teams-ps/teams/Grant-CsTeamsUpdateManagementPolicy.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,22 @@ Use this cmdlet to grant a specific Teams Update Management policy to a user.
1818
## SYNTAX
1919

2020
### Identity (Default)
21-
```
21+
```powershell
2222
Grant-CsTeamsUpdateManagementPolicy [[-Identity] <String>] [-PassThru] [[-PolicyName] <String>]
23-
[-MsftInternalProcessingMode <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
23+
[-MsftInternalProcessingMode <String>] [-ProgressAction <ActionPreference>]
2424
[<CommonParameters>]
2525
```
2626

2727
### GrantToTenant
28-
```
28+
```powershell
2929
Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
30-
[-Global] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
30+
[-Global] [-ProgressAction <ActionPreference>] [<CommonParameters>]
3131
```
3232

3333
### GrantToGroup
34-
```
34+
```powershell
3535
Grant-CsTeamsUpdateManagementPolicy [-PassThru] [[-PolicyName] <String>] [-MsftInternalProcessingMode <String>]
36-
[-Group] <String> [-Rank <Int32>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
36+
[-Group] <String> [-Rank <Int32>] [-ProgressAction <ActionPreference>]
3737
[<CommonParameters>]
3838
```
3939

@@ -51,21 +51,6 @@ In this example, the policy "Campaign Policy" is granted to the user kenmyer@lit
5151

5252
## PARAMETERS
5353

54-
### -Confirm
55-
Prompts you for confirmation before running the cmdlet.
56-
57-
```yaml
58-
Type: SwitchParameter
59-
Parameter Sets: (All)
60-
Aliases: cf
61-
62-
Required: False
63-
Position: Named
64-
Default value: None
65-
Accept pipeline input: False
66-
Accept wildcard characters: False
67-
```
68-
6954
### -Global
7055
Use this parameter to make the specified policy in -PolicyName the new effective global policy.
7156

@@ -156,22 +141,6 @@ Accept pipeline input: False
156141
Accept wildcard characters: False
157142
```
158143
159-
### -WhatIf
160-
Shows what would happen if the cmdlet runs.
161-
The cmdlet is not run.
162-
163-
```yaml
164-
Type: SwitchParameter
165-
Parameter Sets: (All)
166-
Aliases: wi
167-
168-
Required: False
169-
Position: Named
170-
Default value: None
171-
Accept pipeline input: False
172-
Accept wildcard characters: False
173-
```
174-
175144
### CommonParameters
176145
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).
177146

0 commit comments

Comments
 (0)