Skip to content

Commit d87b727

Browse files
chrisdachrisda
authored
Merge pull request #10978 from MicrosoftDocs/DTBC-chrisda
DTBC-chrisda to Main
2 parents afa7ab2 + 3286ba9 commit d87b727

File tree

6 files changed

+194
-12
lines changed

6 files changed

+194
-12
lines changed

‎.openpublishing.redirection.json

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6920,16 +6920,6 @@
69206920
"redirect_url": "/powershell/module/exchange/update-distributiongroupmember",
69216921
"redirect_document_id": false
69226922
},
6923-
{
6924-
"source_path": "exchange/virtual-folder/exchange/Get-DefaultTenantBriefingConfig.md",
6925-
"redirect_url": "/viva/insights/personal/reference/briefing-pause",
6926-
"redirect_document_id": false
6927-
},
6928-
{
6929-
"source_path": "exchange/virtual-folder/exchange/Set-DefaultTenantBriefingConfig.md",
6930-
"redirect_url": "/viva/insights/personal/reference/briefing-pause",
6931-
"redirect_document_id": false
6932-
},
69336923
{
69346924
"source_path": "teams/teams-ps/teams/New-CsTeamsShiftsConnectionTeamMap.yml",
69356925
"redirect_url": "https://review.learn.microsoft.com/en-us/powershell/module/teams/",

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed
163163

164164
|Cmdlet|Comments|
165165
|---|---|
166-
|Get-DefaultTenantBriefingConfig|See [Pausing the briefing email from Microsoft Viva](/viva/insights/personal/reference/briefing-pause).|
167-
|Set-DefaultTenantBriefingConfig|See [Pausing the briefing email from Microsoft Viva](/viva/insights/personal/reference/briefing-pause).|
166+
|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0 or later.|
167+
|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0 or later.|
168168
|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.|
169169
|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.|
170170
|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.|

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://learn.microsoft.com/powershell/module/exchange/get-defaulttenantbriefingconfig
5+
applicable: Exchange Online
6+
title: Get-DefaultTenantBriefingConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer:
11+
---
12+
13+
# Get-DefaultTenantBriefingConfig
14+
15+
## SYNOPSIS
16+
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
17+
18+
Use the Get-DefaultTenantBriefingConfig cmdlet to view the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin).
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+
```
25+
Get-DefaultTenantBriefingConfig
26+
[-ResultSize <Unlimited>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
The default Briefing email configuration for the organization affects only new users and existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.
32+
33+
This cmdlet requires the .NET Framework 4.7.2 or later.
34+
35+
To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:
36+
37+
- Global Administrator
38+
- Exchange Administrator
39+
- Insights Administrator
40+
41+
For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
42+
43+
## EXAMPLES
44+
45+
### Example 1
46+
```
47+
Get-DefaultTenantBriefingConfig
48+
```
49+
50+
This example returns the default Briefing email configuration for the organization.
51+
52+
## PARAMETERS
53+
54+
### -ResultSize
55+
This parameter is reserved for internal Microsoft use.
56+
57+
```yaml
58+
Type: Unlimited
59+
Parameter Sets: (All)
60+
Aliases:
61+
Applicable: Exchange Online
62+
63+
Required: False
64+
Position: Named
65+
Default value: None
66+
Accept pipeline input: False
67+
Accept wildcard characters: False
68+
```
69+
70+
### CommonParameters
71+
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).
72+
73+
## INPUTS
74+
75+
## OUTPUTS
76+
77+
## NOTES
78+
79+
## RELATED LINKS
80+
81+
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

‎exchange/exchange-ps/exchange/Set-DefaultTenantBriefingConfig.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
external help file: Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
3+
Module Name: ExchangeOnlineManagement
4+
online version: https://learn.microsoft.com/powershell/module/exchange/set-defaulttenantbriefingconfig
5+
applicable: Exchange Online
6+
title: Set-DefaultTenantBriefingConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
ms.reviewer:
11+
---
12+
13+
# Set-DefaultTenantBriefingConfig
14+
15+
## SYNOPSIS
16+
This cmdlet is available only in the Exchange Online PowerShell module version 3.2.0 or later. For more information, see [About the Exchange Online PowerShell module](https://aka.ms/exov3-module).
17+
18+
Use the Set-DefaultTenantBriefingConfig cmdlet to modify the default Briefing email configuration in cloud-based organizations. For details about configuring the Briefing email, see [Configure Briefing email](https://learn.microsoft.com/viva/insights/personal/Briefing/be-admin).
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+
```
25+
Set-DefaultTenantBriefingConfig -IsEnabledByDefault <String>
26+
[-ResultSize <Unlimited>]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
This cmdlet requires the .NET Framework 4.7.2 or later.
32+
33+
To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:
34+
35+
- Global Administrator
36+
- Exchange Administrator
37+
- Insights Administrator
38+
39+
For more information, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```
45+
Set-DefaultTenantBriefingConfig -IsEnabledByDefault Opt-in
46+
47+
This example sets the default Briefing email configuration for the organization to receive the Briefing email.
48+
```
49+
50+
## PARAMETERS
51+
52+
### -IsEnabledByDefault
53+
The IsEnabledByDefault parameter specifies the default Briefing email configuration for the organization. Valid values are:
54+
55+
- Opt-in: By default, all users in the organization are subscribed to receive the Briefing email.
56+
- Opt-out: By default, no users in the organization are subscribed to receive the Briefing email. This is the default value.
57+
58+
This setting affects the following users:
59+
60+
- Existing users who haven't already updated their user settings to opt-in or opt-out of the Briefing email.
61+
- New users that you create.
62+
63+
This setting does not affect users who've already updated their user settings to opt-in or opt-out of the Briefing email.
64+
65+
```yaml
66+
Type: String
67+
Parameter Sets: (All)
68+
Aliases:
69+
Applicable: Exchange Online
70+
71+
Required: True
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -ResultSize
79+
This parameter is reserved for internal Microsoft use.
80+
81+
```yaml
82+
Type: Microsoft.Exchange.Management.RestApiClient.Unlimited`1[System.UInt32]
83+
Parameter Sets: (All)
84+
Aliases:
85+
Applicable: Exchange Online
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### CommonParameters
95+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
96+
97+
## INPUTS
98+
99+
## OUTPUTS
100+
101+
## NOTES
102+
103+
## RELATED LINKS
104+
105+
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

‎exchange/exchange-ps/exchange/exchange.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2297,6 +2297,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
22972297

22982298
### [Get-ConnectionInformation](Get-ConnectionInformation.md)
22992299

2300+
### [Get-DefaultTenantBriefingConfig](Get-DefaultTenantBriefingConfig.md)
2301+
23002302
### [Get-DefaultTenantMyAnalyticsFeatureConfig](Get-DefaultTenantMyAnalyticsFeatureConfig.md)
23012303

23022304
### [Get-EXOCasMailbox](Get-EXOCasMailbox.md)
@@ -2331,6 +2333,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
23312333

23322334
### [Remove-VivaModuleFeaturePolicy](Remove-VivaModuleFeaturePolicy.md)
23332335

2336+
### [Set-DefaultTenantBriefingConfig](Set-DefaultTenantBriefingConfig.md)
2337+
23342338
### [Set-DefaultTenantMyAnalyticsFeatureConfig](Set-DefaultTenantMyAnalyticsFeatureConfig.md)
23352339

23362340
### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md)

‎exchange/mapping/serviceMapping.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,6 +1129,7 @@
11291129
"Connect-IPPSSession": "powershell-v2-module",
11301130
"Disconnect-ExchangeOnline": "powershell-v2-module",
11311131
"Get-ConnectionInformation": "powershell-v2-module",
1132+
"Get-DefaultTenantBriefingConfig": "powershell-v2-module",
11321133
"Get-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v2-module",
11331134
"Get-EXOCasMailbox": "powershell-v2-module",
11341135
"Get-EXOMailbox": "powershell-v2-module",
@@ -1146,6 +1147,7 @@
11461147
"Get-VivaModuleFeatureEnablement": "powershell-v2-module",
11471148
"Get-VivaModuleFeaturePolicy": "powershell-v2-module",
11481149
"Remove-VivaModuleFeaturePolicy": "powershell-v2-module",
1150+
"Set-DefaultTenantBriefingConfig": "powershell-v2-module",
11491151
"Set-DefaultTenantMyAnalyticsFeatureConfig": "powershell-v2-module",
11501152
"Set-MyAnalyticsFeatureConfig": "powershell-v2-module",
11511153
"Set-UserBriefingConfig": "powershell-v2-module",

0 commit comments

Comments
 (0)