Remove-CsUserLicenseGracePeriod

Module:

MicrosoftTeamsPowerShell

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). 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.)

Syntax

Remove-CsUserLicenseGracePeriod
      [-Identity] <String>
      [-Capability <String>]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

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

Get-CsOnlineUser -Identity bf19b7db-6960-41e5-a139-2aa373474354

Examples

Example 1

Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354

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.

Example 2

Remove-CsUserLicenseGracePeriod -Identity bf19b7db-6960-41e5-a139-2aa373474354 -Capability 'MCOEV,MCOMEETADD'

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.

Parameters

-Capability

Denotes the plan(s) assigned to the specified user, which are to be permanently deleted if they are currently serving their grace period.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Identity

Specifies the Identity (GUID) of the user account whose assigned plan grace period needs to be removed, permanently deleting the subsequent plan.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Outputs

System.Object

Related Links

• Get-CsOnlineUser