Skip to content

Commit fd9b8ec

Browse files
chrisdachrisda
committed
Merge branch 'master' into OLMeetings-chrisda
2 parents 567ba5c + ef2af3e commit fd9b8ec

File tree

4 files changed

+193
-0
lines changed

4 files changed

+193
-0
lines changed

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

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
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-userbriefingconfig
5+
applicable: Exchange Online
6+
title: Get-UserBriefingConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
monikerRange: "exchonline-ps"
11+
---
12+
13+
# Get-UserBriefingConfig
14+
15+
## SYNOPSIS
16+
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).
17+
18+
Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin).
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Get-UserBriefingConfig -Identity <string> [-ResultSize <Unlimited>]
26+
```
27+
28+
## DESCRIPTION
29+
Gets the current state of the Briefing email flag (true or false) for the specified user.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```powershell
35+
Get-UserBriefingConfig -Identity [email protected]
36+
```
37+
38+
This example returns the Briefing configuration for the user [email protected].
39+
40+
## PARAMETERS
41+
42+
### -Identity
43+
The Identity parameter specifies the user that you want to view (for example, [email protected]).
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
Applicable: Exchange Online
50+
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -ResultSize
59+
This parameter is reserved for internal Microsoft use.
60+
61+
```yaml
62+
Type: Unlimited
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: Exchange Online
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False Accept pipeline input: False
70+
Accept wildcard characters: False Accept wildcard characters: False
71+
```
72+
73+
## INPUTS
74+
75+
###
76+
77+
## OUTPUTS
78+
79+
###
80+
81+
## Related links
82+
83+
[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin)

‎exchange/exchange-ps/exchange/Set-UserBriefingConfig.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/set-userbriefingconfig
5+
applicable: Exchange Online
6+
title: Set-UserBriefingConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
monikerRange: "exchonline-ps"
11+
---
12+
13+
# Set-UserBriefingConfig
14+
15+
## SYNOPSIS
16+
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online/exchange-online-powershell-v2/exchange-online-powershell-v2).
17+
18+
Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing for a user. For more details about configuring the Briefing, see [Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin).
19+
20+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax).
21+
22+
## SYNTAX
23+
24+
```
25+
Set-UserBriefingConfig -Identity <String> [-Enabled [<$true | $false>] [-ResultSize <Unlimited>]
26+
```
27+
28+
## DESCRIPTION
29+
To enable or disable Briefing email for a specific user, use the Exchange Online PowerShell V2 module and this command line, where the string is the applicable username.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
```powershell
36+
Set-UserBriefingConfig -Identity [email protected] -Enabled $true
37+
```
38+
39+
This example enables the Briefing email for [email protected].
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
The Identity parameter specifies the user that you want to modify (for example, [email protected]).
45+
46+
```yaml
47+
Type: String
48+
Parameter Sets: (All)
49+
Aliases:
50+
Applicable: Exchange Online
51+
52+
Required: True
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### -Enabled
60+
The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:
61+
62+
- $true: The daily briefing message is enabled.
63+
64+
- $false: The daily briefing message is disabled. This is the default value.
65+
66+
```yaml
67+
Type: Boolean
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Exchange Online
71+
72+
Required: True
73+
Position: Named
74+
Default value: False
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+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False Accept pipeline input: False
91+
Accept wildcard characters: False Accept wildcard characters: False
92+
```
93+
94+
## INPUTS
95+
96+
###
97+
98+
## OUTPUTS
99+
100+
###
101+
102+
## RELATED LINKS
103+
104+
[Configure Briefing email](https://docs.microsoft.com/Briefing/be-admin)

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

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

20302030
### [Get-EXORecipientPermission](Get-EXORecipientPermission.md)
20312031

2032+
### Get-UserBriefingConfig](Get-UserBriefingConfig.md)
2033+
2034+
### Set-UserBriefingConfig](Set-UserBriefingConfig.md)
2035+
20322036
## reporting Cmdlets
20332037
### [Get-ConnectionByClientTypeDetailReport](Get-ConnectionByClientTypeDetailReport.md)
20342038

‎exchange/mapping/serviceMapping.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -995,6 +995,8 @@
995995
"Get-EXOMobileDeviceStatistics": "powershell-v2-module",
996996
"Get-EXORecipient": "powershell-v2-module",
997997
"Get-EXORecipientPermission": "powershell-v2-module",
998+
"Get-UserBriefingConfig": "powershell-v2-module",
999+
"Set-UserBriefingConfig": "powershell-v2-module",
9981000
"Get-ConnectionByClientTypeDetailReport": "reporting",
9991001
"Get-ConnectionByClientTypeReport": "reporting",
10001002
"Get-CsActiveUserReport": "reporting",

0 commit comments

Comments
 (0)