New-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 New-CustomNudgeAssignment cmdlet to assign Custom Nudges to 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

New-CustomNudgeAssignment
   -AssigneeId <String>
   -NudgeName <String>
   [-EndTime <String>]
   [-ResultSize <Unlimited>]
   [-StartTime <String>]
   [<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

New-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId roy@contoso.onmicrosoft.com -StartTime 2/2/2022 -EndTime 2/10/2022

This example assigns the Custom Nudge named perfReviewNudge to the user roy@contoso.onmicrosoft.com. If the Custom Nudge feature is enabled in the organization, and the current time is between the StartTime and EndTime values, the user will see the perfReviewNudge Custom Nudge in their next Briefing email message.

Parameters

-AssigneeId

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

Together, this parameter and the NudgeName parameter create the unique Custom Nudge assignment.

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

The EndTime parameter specifies the date when the Custom Nudge is no longer shown to the user.

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 that you want to assign to the user. If the value contains spaces, enclose the value in quotation marks (").

Together, this parameter and the AssigneeId parameter create the unique Custom Nudge assignment.

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
-StartTime

The StartTime parameter specifies the date when the Custom Nudge is first shown to the user.

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