|
| 1 | +--- |
| 2 | +external help file: Microsoft.Exchange.RolesAndAccess-Help.xml |
| 3 | +online version: https://learn.microsoft.com/powershell/module/exchange/get-pendingdelicenseuser |
| 4 | +applicable: Exchange Online |
| 5 | +title: Get-PendingDelicenseUser |
| 6 | +schema: 2.0.0 |
| 7 | +author: chrisda |
| 8 | +ms.author: chrisda |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | + |
| 13 | +# Get-PendingDelicenseUser |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | +This cmdlet is available only in the cloud-based service. |
| 17 | + |
| 18 | +Use the Get-PendingDelicenseUser cmdlet to view information about mailboxes that have delayed mailbox license removal requests. You configure delayed mailbox license removal using the DelayedDelicensingEnabled parameter on the Set-OrganizationConfig cmdlet. |
| 19 | + |
| 20 | +For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax). |
| 21 | + |
| 22 | +## SYNTAX |
| 23 | + |
| 24 | +### Identity (Default) |
| 25 | +``` |
| 26 | +Get-PendingDelicenseUser [[-Identity] <RecipientIdParameter>] |
| 27 | + [<CommonParameters>] |
| 28 | +``` |
| 29 | + |
| 30 | +### TenantLevelParameterSet |
| 31 | +``` |
| 32 | +Get-PendingDelicenseUser [-ResultSize <Unlimited>] [-ShowDueObjectsOnly] |
| 33 | + [<CommonParameters>] |
| 34 | +``` |
| 35 | + |
| 36 | +## DESCRIPTION |
| 37 | +You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions). |
| 38 | + |
| 39 | +## EXAMPLES |
| 40 | + |
| 41 | +### Example 1 |
| 42 | +```powershell |
| 43 | +Get-PendingDelicenseUser | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC |
| 44 | +``` |
| 45 | + |
| 46 | +This example returns a summary list of all mailboxes that have pending mailbox license removal requests. |
| 47 | + |
| 48 | +### Example 2 |
| 49 | +```powershell |
| 50 | +Get-PendingDelicenseUser -Identity yajvendra@contoso.onmicrosoft.com |
| 51 | +``` |
| 52 | + |
| 53 | +This example returns detailed information about the pending mailbox license removal request for the specified mailbox. |
| 54 | + |
| 55 | +### Example 3 |
| 56 | +```powershell |
| 57 | +Get-PendingDelicenseUser -ShowDueObjectsOnly | Format-Table DisplayName,UserPrincipalName,WhenDueForDelicensingUTC |
| 58 | +``` |
| 59 | + |
| 60 | +This example returns a summary list of all mailboxes where the 30 day delay for mailbox license removal requests has ended, so the licenses can be removed from the mailboxes at any time. |
| 61 | + |
| 62 | +## PARAMETERS |
| 63 | + |
| 64 | +### -Identity |
| 65 | +The Identity parameter specifies the mailbox with a pending mailbox license removal request. |
| 66 | + |
| 67 | +You can use any value that uniquely identifies the mailbox. For example: |
| 68 | + |
| 69 | +- Name |
| 70 | +- Alias |
| 71 | +- Distinguished name (DN) |
| 72 | +- Email address |
| 73 | +- GUID |
| 74 | +- LegacyExchangeDN |
| 75 | +- User ID or user principal name (UPN) |
| 76 | + |
| 77 | +You can't use this parameter with the ShowDueObjectsOnly switch. |
| 78 | + |
| 79 | +```yaml |
| 80 | +Type: RecipientIdParameter |
| 81 | +Parameter Sets: Identity |
| 82 | +Aliases: |
| 83 | +Applicable: Exchange Online |
| 84 | + |
| 85 | +Required: False |
| 86 | +Position: 1 |
| 87 | +Default value: None |
| 88 | +Accept pipeline input: False |
| 89 | +Accept wildcard characters: False |
| 90 | +``` |
| 91 | +
|
| 92 | +### -ResultSize |
| 93 | +The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: Unlimited |
| 97 | +Parameter Sets: TenantLevelParameterSet |
| 98 | +Aliases: |
| 99 | +Applicable: Exchange Online |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### -ShowDueObjectsOnly |
| 109 | +The ShowDueObjectsOnly switch filters the results by mailboxes where the 30 day delay for removing the license has ended, and the license can be removed from the mailbox at any time. You don't need to specify a value with this switch. |
| 110 | +
|
| 111 | +You can't use this switch with the Identity parameter. |
| 112 | +
|
| 113 | +```yaml |
| 114 | +Type: SwitchParameter |
| 115 | +Parameter Sets: TenantLevelParameterSet |
| 116 | +Aliases: |
| 117 | +Applicable: Exchange Online |
| 118 | + |
| 119 | +Required: False |
| 120 | +Position: Named |
| 121 | +Default value: False |
| 122 | +Accept pipeline input: False |
| 123 | +Accept wildcard characters: False |
| 124 | +``` |
| 125 | +
|
| 126 | +### CommonParameters |
| 127 | +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/p/?LinkID=113216). |
| 128 | +
|
| 129 | +## INPUTS |
| 130 | +
|
| 131 | +## OUTPUTS |
| 132 | +
|
| 133 | +## NOTES |
| 134 | +
|
| 135 | +## RELATED LINKS |
0 commit comments