Skip to content

Commit 6268d4f

Browse files
authored
Update Remove-CsUserLicenseGracePeriod
Updates for format/style. The one change that potentially affects the technical content is capitalization of "-capability" in example 2 (capability is capitalized in the Syntex section and the Parameters section).
1 parent d0b6f20 commit 6268d4f

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

teams/teams-ps/teams/Remove-CsUserLicenseGracePeriod

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,65 @@
22
external help file: Microsoft.Teams.Policy.Administration.Cmdlets.Core.dll-Help.xml
33
Module Name: MicrosoftTeams
44
online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserlicensegraceperiod
5+
title: Remove-CsUserLicenseGracePeriod
6+
description: This cmdlet expedites the delicensing operation for an account’s assigned plans by removing the grace period, permanently deleting the assigned plans.
57
schema: 2.0.0
8+
ms.date: 02/01/2024
9+
author: dShyam01
610
---
711

812
# Remove-CsUserLicenseGracePeriod
913

1014
## SYNOPSIS
11-
The \`CsUserLicenseGracePeriod\` cmdlet expedites the delicensing operation for the assigned plan(s) of a user/resource account by removing the grace period, permanently deleting the assigned plan(s).
12-
Note that this cmdlet is to be used only by tenants with license resiliency enabled. (License resiliency is currently under private preview and not available for everyone)
15+
16+
The `CsUserLicenseGracePeriod` cmdlet expedites the delicensing operation for the assigned plan(s) of a user/resource account by removing the grace period, permanently deleting the assigned plan(s).
17+
Note that this cmdlet is to be used only by tenants with license resiliency enabled. (License resiliency is currently under private preview and not available for everyone.)
1318

1419
## SYNTAX
1520

16-
```
17-
Remove-CsUserLicenseGracePeriod [-Identity] <String> [-Capability <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```powershell
22+
Remove-CsUserLicenseGracePeriod
23+
[-Identity] <String>
24+
[-Capability <String>]
25+
[-Force]
26+
[-WhatIf]
27+
[-Confirm]
28+
[<CommonParameters>]
1829
```
1930

2031
## DESCRIPTION
32+
2133
The command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s).
2234
Permanently deletes all/specified plans belonging to the user, which has a grace period assosciated with it.
2335
Assigned plans with no subsequent grace period will see no change.
2436

2537
If you want to verify the grace period of any assigned plan against a user, you can return that information by using this command:
2638

27-
\`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354\`
39+
`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354`
2840

2941
## EXAMPLES
3042

3143
### Example 1
32-
```
44+
45+
```powershell
3346
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354
3447
```
3548

36-
In the example shown above, the command will remove the grace period of all assigned plan(s) against the specified user ID, marking the subsequent assigned plan(s) as deleted. Assigned plans with no subsequent grace period will see no change.
49+
In Example 1, the command removes the grace period of all assigned plan(s) against the specified user ID, marking the subsequent assigned plan(s) as deleted. Assigned plans with no subsequent grace period will see no change.
3750

3851
### Example 2
39-
```
40-
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -capability 'MCOEV,MCOMEETADD'
52+
53+
```powershell
54+
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -Capability 'MCOEV,MCOMEETADD'
4155
```
4256

43-
In Example 2 the capability specified refers to plans assigned to the user(s) under AssignedPlans. The command will remove the grace period of the specified assigned plans, marking the subsequent plan(s) as deleted.
57+
In Example 2, the capability specified refers to plans assigned to the user(s) under AssignedPlans. The command removes the grace period of the specified assigned plans, marking the subsequent plan(s) as deleted.
4458

4559
## PARAMETERS
4660

4761
### -Identity
48-
Specifies the Identity(GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan.
62+
63+
Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan.
4964

5065
```yaml
5166
Type: String
@@ -60,7 +75,8 @@ Accept wildcard characters: False
6075
```
6176

6277
### -Capability
63-
Denotes the plan(s) assigned to the specified user, which are to be permanently deleted if they are currently serving their grace period.
78+
79+
Denotes the plan(s) assigned to the specified user, which are to be permanently deleted if they are currently serving their grace period.
6480

6581
```yaml
6682
Type: String
@@ -73,7 +89,9 @@ Default value: None
7389
Accept pipeline input: True (ByPropertyName,ByValue)
7490
Accept wildcard characters: False
7591
```
92+
7693
### -Confirm
94+
7795
Prompts you for confirmation before running the cmdlet.
7896

7997
```yaml
@@ -89,14 +107,17 @@ Accept wildcard characters: False
89107
```
90108

91109
### CommonParameters
110+
92111
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).
93112

94113
## INPUTS
95114

96115
## OUTPUTS
116+
97117
System.Object
98118

99119
## NOTES
100120

101121
## RELATED LINKS
102-
[Get-CsOnlineUser]()
122+
123+
[Get-CsOnlineUser](teams\teams-ps\teams\Get-CsOnlineUser.md)

0 commit comments

Comments
 (0)