Skip to content

Commit 8f19f47

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#10583 from MicrosoftDocs/DefaultTenant-chrisda
DefaultTenant-chrisda to Main
2 parents 1aa99b1 + ee3f328 commit 8f19f47

File tree

6 files changed

+456
-0
lines changed

6 files changed

+456
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ Miscellaneous Exchange Online cmdlets that happen to be in the module are listed
156156

157157
|Cmdlet|Comments|
158158
|---|---|
159+
|[Get-DefaultTenantBriefingConfig](/powershell/module/exchange/get-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.|
160+
|[Set-DefaultTenantBriefingConfig](/powershell/module/exchange/set-defaulttenantbriefingconfig)|Available in v3.2.0-Preview1 or later.|
161+
|[Get-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/get-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.|
162+
|[Set-DefaultTenantMyAnalyticsFeatureConfig](/powershell/module/exchange/set-defaulttenantmyanalyticsfeatureconfig)|Available in v3.2.0-Preview1 or later.|
159163
|[Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig)|Available in v2.0.4 or later.|
160164
|[Set-MyAnalyticsFeatureConfig](/powershell/module/exchange/set-myanalyticsfeatureconfig)|Available in v2.0.4 or later.|
161165
|[Get-UserBriefingConfig](/powershell/module/exchange/get-userbriefingconfig)|Replaced by [Get-MyAnalyticsFeatureConfig](/powershell/module/exchange/get-myanalyticsfeatureconfig).|

‎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-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 [-ResultSize <Unlimited>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
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.
30+
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, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-DefaultTenantBriefingConfig
46+
```
47+
48+
This example returns the default Briefing email configuration for the organization. The value opt-in for the PrivacyMode property indicates that the organization has elected to receive the Briefing email by default.
49+
50+
## PARAMETERS
51+
52+
### -ResultSize
53+
This parameter is reserved for internal Microsoft use.
54+
55+
```yaml
56+
Type: Unlimited
57+
Parameter Sets: (All)
58+
Aliases:
59+
Applicable: Exchange Online
60+
61+
Required: False
62+
Position: Named
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### CommonParameters
69+
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).
70+
71+
## INPUTS
72+
73+
## OUTPUTS
74+
75+
## NOTES
76+
77+
We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios.
78+
79+
## RELATED LINKS
80+
81+
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
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-defaulttenantmyanalyticsfeatureconfig
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-DefaultTenantMyAnalyticsFeatureConfig
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 availability and status of Viva Insights features for the cloud-based organization: digest email, add-in, dashboard, meeting effectiveness survey, and schedule send suggestions.
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-DefaultTenantMyAnalyticsFeatureConfig [-ResultSize <Unlimited]>] [<CommonParameters>]
26+
```
27+
28+
## DESCRIPTION
29+
This cmdlet requires the .NET Framework 4.7.2 or later.
30+
31+
To run this cmdlet, you need to be a member of one of the following directory role groups in the destination organization:
32+
33+
- Global Administrator
34+
- Exchange Administrator
35+
- Insights Administrator
36+
37+
For more information, see, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
```powershell
43+
Get-DefaultTenantMyAnalyticsFeatureConfig
44+
```
45+
46+
This example returns the default opt-in or opt-out information for the various Viva Insights settings.
47+
48+
## PARAMETERS
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+
We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios.
76+
77+
## RELATED LINKS
78+
79+
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

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

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
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-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 -PrivacyMode <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, see [Azure AD built-in roles](https://learn.microsoft.com/azure/active-directory/roles/permissions-reference).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Set-DefaultTenantBriefingConfig -PrivacyMode 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+
### -PrivacyMode
53+
The PrivacyMode 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+
Accepted values: Opt-in, Opt-out
70+
Applicable: Exchange Online
71+
72+
Required: True
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -ResultSize
80+
This parameter is reserved for internal Microsoft use.
81+
82+
```yaml
83+
Type: Unlimited
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: Exchange Online
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### CommonParameters
96+
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).
97+
98+
## INPUTS
99+
100+
## OUTPUTS
101+
102+
## NOTES
103+
104+
We're in the process of verifying that this cmdlet works for guest user, DAP, and GDAP scenarios.
105+
106+
## RELATED LINKS
107+
108+
[Deploy personal insights](https://learn.microsoft.com/viva/insights/personal/setup/deployment-guide)

0 commit comments

Comments
 (0)