Skip to content

Commit 86949e4

Browse files
chrisdachrisda
committed
Get/Set-DefaultTenantBriefingConfig
1 parent c48c011 commit 86949e4

File tree

2 files changed

+186
-0
lines changed

2 files changed

+186
-0
lines changed

‎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-DefaultTenantMyAnalyticsFeatureConfig
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-Preview1 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-DefaultTenantMyAnalyticsFeatureConfig
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-Preview1 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)

0 commit comments

Comments
 (0)