Remove-CustomNudgeAssignment

This cmdlet is available only in the Exchange Online PowerShell V2 module v2.0.6-Preview5 or later. For more information, see About the Exchange Online PowerShell V2 module.

Note: The features that are associated with this cmdlet are currently in Preview, are not available in all organizations, and are subject to change. Access to the cmdlet does not guarantee access to the feature.

Use the Remove-CustomNudgeAssignment cmdlet to remove the assignments of Custom Nudges from users. Custom Nudges are shown in the Briefing email.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Remove-CustomNudgeAssignment
      -AssigneeId <String>
      -NudgeName <String>
      [-ResultSize <Unlimited>]
      [<CommonParameters>]

Description

This cmdlet requires the .NET Framework 4.7.2 or later. To run this cmdlet, you need to be a member of one of the following roles in Azure Active Directory:

  • Global Administrator
  • Exchange Administrator
  • Insights Administrator

To learn more about administrator role permissions in Azure Active Directory, see Azure AD built-in roles.

Examples

Example 1

Remove-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com

This example removes the assignment of the Custom Nudge named perfReviewNudge from the user roy@contoso.onmicrosoft.com.

Parameters

-AssigneeId

The AssigneeId parameter specifies the email address of the user in the Custom Nudge assignment that you want to remove.

Together, this parameter and the AssigneeId parameter uniquely identify the Custom Nudge assignment that you want to remove.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-NudgeName

The NudgeName parameter specifies the name of the Custom Nudge in the Custom Nudge assignment that you want to remove. If the value contains spaces, enclose the value in quotation marks (").

Together, this parameter and the AssigneeId parameter uniquely identify the Custom Nudge assignment that you want to remove.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ResultSize

This parameter is reserved for internal Microsoft use.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online