Skip to content

Commit caa6a51

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#9756 from MicrosoftDocs/CNudge-chrisda
CNudge-chrisda to Main
2 parents f7173eb + 245c90c commit caa6a51

14 files changed

+1273
-3
lines changed

‎exchange/docs-conceptual/exchange-online-powershell-v2.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,22 @@ Miscellaneous Exchange Online cmdlets that happen to be in the EXO V2 module are
7474

7575
|EXO V2 module cmdlet|Comments|
7676
|---|---|
77+
|[Get-CustomNudge](/powershell/module/exchange/get-customnudge)|Available in v2.0.6-Preview5 or later|
78+
|[New-CustomNudge](/powershell/module/exchange/new-customnudge)|Available in v2.0.6-Preview5 or later|
79+
|[Remove-CustomNudge](/powershell/module/exchange/remove-customnudge)|Available in v2.0.6-Preview5 or later|
80+
|[Set-CustomNudge](/powershell/module/exchange/set-customnudge)|Available in v2.0.6-Preview5 or later|
81+
|[Get-CustomNudgeAssignment](/powershell/module/exchange/get-customnudgeassignment)|Available in v2.0.6-Preview5 or later|
82+
|[New-CustomNudgeAssignment](/powershell/module/exchange/new-customnudgeassignment)|Available in v2.0.6-Preview5 or later|
83+
|[Remove-CustomNudgeAssignment](/powershell/module/exchange/remove-customnudgeassignment)|Available in v2.0.6-Preview5 or later|
84+
|[Set-CustomNudgeAssignment](/powershell/module/exchange/set-customnudgeassignment)|Available in v2.0.6-Preview5 or later|
85+
|[Get-CustomNudgeSettings](/powershell/module/exchange/get-customnudgesettings)|Available in v2.0.6-Preview5 or later|
86+
|[Set-CustomNudgeSettings](/powershell/module/exchange/set-customnudgesettings)|Available in v2.0.6-Preview5 or later|
7787
|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.|
7888
|[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.|
7989
|[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).|
8090
|[Set-UserBriefingConfig](/powershell/module/exchange/set-userbriefingconfig)|Replaced by [Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig).|
81-
|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5-Preview2 or later.|
82-
|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5-Preview2 or later.|
91+
|[Get-VivaInsightsSettings](/powershell/module/exchange/get-vivainsightssettings)|Available in v2.0.5 or later.|
92+
|[Set-VivaInsightsSettings](/powershell/module/exchange/set-vivainsightssettings)|Available in v2.0.5 or later.|
8393

8494
### Updates for version 2.0.6
8595

‎exchange/exchange-ps/exchange/Get-CustomNudge.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudge
5+
applicable: Exchange Online
6+
title: Get-CustomNudge
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer: shusun
11+
---
12+
13+
# Get-CustomNudge
14+
15+
## SYNOPSIS
16+
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](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
18+
**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.
19+
20+
Use the Get-CustomNudge cmdlet to view Custom Nudges that are displayed in user Briefing email messages.
21+
22+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
23+
24+
## SYNTAX
25+
26+
```
27+
Get-CustomNudge [-Name <string>]
28+
[-ResultSize <Unlimited>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
Custom Nudges that are assigned to users appear their Briefing email messages. Users can mark Custom Nudges as complete after they finish the task.
34+
35+
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:
36+
37+
- Global Administrator
38+
- Exchange Administrator
39+
- Insights Administrator
40+
41+
To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference).
42+
43+
## EXAMPLES
44+
45+
### Example 1
46+
```powershell
47+
Get-CustomNudge | Format-Table Name,Title,From
48+
```
49+
50+
This example returns a summary list all Custom Nudges in the organization.
51+
52+
### Example 2
53+
```powershell
54+
Get-CustomNudge -Name Nudge 01
55+
```
56+
57+
This example returns detailed information for the Custom Nudge named Nudge 01.
58+
59+
## PARAMETERS
60+
61+
### -Name
62+
The Name parameter specifies the name of the Custom Nudge that you want to view. If the value contains spaces, enclose the value in quotation marks (").
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: (All)
67+
Aliases:
68+
Applicable: Exchange Online
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -ResultSize
78+
This parameter is reserved for internal Microsoft use.
79+
80+
```yaml
81+
Type: Unlimited
82+
Parameter Sets: (All)
83+
Aliases:
84+
Applicable: Exchange Online
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
94+
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).
95+
96+
## INPUTS
97+
98+
## OUTPUTS
99+
100+
## NOTES
101+
102+
## RELATED LINKS
103+
104+
[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin)

‎exchange/exchange-ps/exchange/Get-CustomNudgeAssignment.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudgeassignment
5+
applicable: Exchange Online
6+
title: Get-CustomNudgeAssignment
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer: shusun
11+
---
12+
13+
# Get-CustomNudgeAssignment
14+
15+
## SYNOPSIS
16+
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](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
18+
**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.
19+
20+
Use the Get-CustomNudgeAssignment to view the assignments of Custom Nudges to users. Custom Nudges are shown in the Briefing email.
21+
22+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
23+
24+
## SYNTAX
25+
26+
```
27+
Get-CustomNudgeAssignment [-AssigneeId <String>] [-NudgeName <String>]
28+
[-ResultSize <Unlimited>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
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:
34+
35+
- Global Administrator
36+
- Exchange Administrator
37+
- Insights Administrator
38+
39+
To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-CustomNudgeAssignment -NudgeName perfReviewNudge
46+
```
47+
48+
This example returns all assignments that contain the Custom Nudge named perfReviewNudge.
49+
50+
### Example 2
51+
```powershell
52+
Get-CustomNudgeAssignment -AssigneeId [email protected]
53+
```
54+
55+
This example returns all assignments that contain the user [email protected].
56+
57+
### Example 3
58+
```powershell
59+
Get-CustomNudgeAssignment -NudgeName perfReviewNudge -AssigneeId [email protected]
60+
```
61+
62+
This example returns the StartTime and EndTime values for the assignment of the Custom Nudge named perfReviewNudge to the user [email protected].
63+
64+
## PARAMETERS
65+
66+
### -AssigneeId
67+
The AssigneeId parameter specifies the email address of the user that you want to view.
68+
69+
If you use this parameter without the NudgeName parameter, all Custom Nudges that are assigned to the user are returned.
70+
71+
If you use this parameter with the NudgeName parameter, the StartDate and EndDate values of the assignment are returned.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
Applicable: Exchange Online
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -NudgeName
87+
The NudgeName parameter filters the assignments by the name of the Custom Nudge. If the value contains spaces, enclose the value in quotation marks (").
88+
89+
If you use this parameter without the AssigneeId parameter, all users who have the Custom Nudge assigned to them are returned.
90+
91+
If you use this parameter with the AssigneeId parameter, the StartDate and EndDate values of the assignment are returned.
92+
93+
```yaml
94+
Type: String
95+
Parameter Sets: (All)
96+
Aliases:
97+
Applicable: Exchange Online
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -ResultSize
107+
This parameter is reserved for internal Microsoft use.
108+
109+
```yaml
110+
Type: Unlimited
111+
Parameter Sets: (All)
112+
Aliases:
113+
Applicable: Exchange Online
114+
115+
Required: False
116+
Position: Named
117+
Default value: None
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
122+
### CommonParameters
123+
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).
124+
125+
## INPUTS
126+
127+
## OUTPUTS
128+
129+
## NOTES
130+
131+
## RELATED LINKS

‎exchange/exchange-ps/exchange/Get-CustomNudgeSettings.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://docs.microsoft.com/powershell/module/exchange/get-customnudgesettings
5+
applicable: Exchange Online
6+
title: Get-CustomNudgeSettings
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer: shusun
11+
---
12+
13+
# Get-CustomNudgeSettings
14+
15+
## SYNOPSIS
16+
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](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
18+
**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.
19+
20+
Use the Get-CustomNudgeSettings cmdlet to view the organization settings for Custom Nudges. Custom Nudges are shown in the Briefing email.
21+
22+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
23+
24+
## SYNTAX
25+
26+
```
27+
Get-CustomNudgeSettings
28+
[-ResultSize <Unlimited>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
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:
34+
35+
- Global Administrator
36+
- Exchange Administrator
37+
- Insights Administrator
38+
39+
To learn more about administrator role permissions in Azure Active Directory, see [Azure AD built-in roles](https://docs.microsoft.com/azure/active-directory/roles/permissions-reference).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-CustomNudgeSettings
46+
```
47+
48+
This example returns the Custom Nudge settings for the organization.
49+
50+
### -ResultSize
51+
This parameter is reserved for internal Microsoft use.
52+
53+
```yaml
54+
Type: Unlimited
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: Exchange Online
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### CommonParameters
67+
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).
68+
69+
## INPUTS
70+
71+
## OUTPUTS
72+
73+
## NOTES
74+
75+
## RELATED LINKS

0 commit comments

Comments
 (0)