Get-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 Get-CustomNudgeAssignment to view the assignments of 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

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

Get-CustomNudgeAssignment -NudgeName perfReviewNudge

This example returns all assignments that contain the Custom Nudge named perfReviewNudge.

Example 2

Get-CustomNudgeAssignment -AssigneeId roy@contoso.onmicrosoft.com

This example returns all assignments that contain the user roy@contoso.onmicrosoft.com.

Example 3

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

This example returns the StartTime and EndTime values for the assignment of the Custom Nudge named perfReviewNudge to the user roy@contoso.com.

Parameters

-AssigneeId

The AssigneeId parameter specifies the email address of the user that you want to view.

If you use this parameter without the NudgeName parameter, all Custom Nudges that are assigned to the user are returned.

If you use this parameter with the NudgeName parameter, the StartDate and EndDate values of the assignment are returned.

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

The NudgeName parameter filters the assignments by the name of the Custom Nudge. If the value contains spaces, enclose the value in quotation marks (").

If you use this parameter without the AssigneeId parameter, all users who have the Custom Nudge assigned to them are returned.

If you use this parameter with the AssigneeId parameter, the StartDate and EndDate values of the assignment are returned.

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