Skip to content

Commit d8736a8

Browse files
authored
Merge pull request MicrosoftDocs#11602 from dShyam01/patch-1
Documentation approval for cmdlet 'Remove-CsUserLicenseGracePeriod'
2 parents 57496db + 6268d4f commit d8736a8

File tree

1 file changed

+123
-0
lines changed

1 file changed

+123
-0
lines changed
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/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.
7+
schema: 2.0.0
8+
ms.date: 02/01/2024
9+
author: dShyam01
10+
---
11+
12+
# Remove-CsUserLicenseGracePeriod
13+
14+
## SYNOPSIS
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.)
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Remove-CsUserLicenseGracePeriod
23+
[-Identity] <String>
24+
[-Capability <String>]
25+
[-Force]
26+
[-WhatIf]
27+
[-Confirm]
28+
[<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
32+
33+
The command removes the grace period of the assigned plan(s) against the specified user(s)/resource account(s), permanently deleting the plan(s).
34+
Permanently deletes all/specified plans belonging to the user, which has a grace period assosciated with it.
35+
Assigned plans with no subsequent grace period will see no change.
36+
37+
If you want to verify the grace period of any assigned plan against a user, you can return that information by using this command:
38+
39+
`Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354`
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
45+
```powershell
46+
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354
47+
```
48+
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.
50+
51+
### Example 2
52+
53+
```powershell
54+
Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -Capability 'MCOEV,MCOMEETADD'
55+
```
56+
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.
58+
59+
## PARAMETERS
60+
61+
### -Identity
62+
63+
Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
70+
Required: True
71+
Position: 1
72+
Default value: None
73+
Accept pipeline input: True (ByPropertyName,ByValue)
74+
Accept wildcard characters: False
75+
```
76+
77+
### -Capability
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.
80+
81+
```yaml
82+
Type: String
83+
Parameter Sets: (All)
84+
Aliases:
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: True (ByPropertyName,ByValue)
90+
Accept wildcard characters: False
91+
```
92+
93+
### -Confirm
94+
95+
Prompts you for confirmation before running the cmdlet.
96+
97+
```yaml
98+
Type: SwitchParameter
99+
Parameter Sets: (All)
100+
Aliases: cf
101+
102+
Required: False
103+
Position: Named
104+
Default value: False
105+
Accept pipeline input: False
106+
Accept wildcard characters: False
107+
```
108+
109+
### CommonParameters
110+
111+
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).
112+
113+
## INPUTS
114+
115+
## OUTPUTS
116+
117+
System.Object
118+
119+
## NOTES
120+
121+
## RELATED LINKS
122+
123+
[Get-CsOnlineUser](teams\teams-ps\teams\Get-CsOnlineUser.md)

0 commit comments

Comments
 (0)