Skip to content

Commit d0b6f20

Browse files
authored
Create Remove-CsUserLicenseGracePeriod
The cmdlet was implemented to aid the delay delicensing feature in Teams, which enables tenant admins to reverse an assigned plan deletion by introducing a configurable grace period, during which the licenses will still be active. In case the plan was deleted accidentally, the admin can reverse the same. If not, running this command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s).
1 parent 15e4db4 commit d0b6f20

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
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/remove-csuserlicensegraceperiod
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-CsUserLicenseGracePeriod
9+
10+
## 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)
13+
14+
## SYNTAX
15+
16+
```
17+
Remove-CsUserLicenseGracePeriod [-Identity] <String> [-Capability <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s).
22+
Permanently deletes all/specified plans belonging to the user, which has a grace period assosciated with it.
23+
Assigned plans with no subsequent grace period will see no change.
24+
25+
If you want to verify the grace period of any assigned plan against a user, you can return that information by using this command:
26+
27+
\`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354\`
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```
33+
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354
34+
```
35+
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.
37+
38+
### Example 2
39+
```
40+
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -capability 'MCOEV,MCOMEETADD'
41+
```
42+
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.
44+
45+
## PARAMETERS
46+
47+
### -Identity
48+
Specifies the Identity(GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
55+
Required: True
56+
Position: 1
57+
Default value: None
58+
Accept pipeline input: True (ByPropertyName,ByValue)
59+
Accept wildcard characters: False
60+
```
61+
62+
### -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.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: True (ByPropertyName,ByValue)
74+
Accept wildcard characters: False
75+
```
76+
### -Confirm
77+
Prompts you for confirmation before running the cmdlet.
78+
79+
```yaml
80+
Type: SwitchParameter
81+
Parameter Sets: (All)
82+
Aliases: cf
83+
84+
Required: False
85+
Position: Named
86+
Default value: False
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### CommonParameters
92+
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).
93+
94+
## INPUTS
95+
96+
## OUTPUTS
97+
System.Object
98+
99+
## NOTES
100+
101+
## RELATED LINKS
102+
[Get-CsOnlineUser]()

0 commit comments

Comments
 (0)