Skip to content

Commit f5b4c20

Browse files
authored
Merge branch 'master' into master
2 parents 024121a + 626e93d commit f5b4c20

File tree

11 files changed

+463
-110
lines changed

11 files changed

+463
-110
lines changed

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

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The module use modern authentication for all cmdlets. You can't use Basic authen
4646

4747
The Exchange Online cmdlets in the EXO V2 module are meant to replace their older, less efficient equivalents, but the equivalent cmdlets are still available (after you connect).
4848

49-
The Exchange Online PowerShell cmdlets that are only available in the EXO V2 module are listed in the following table:
49+
The improved Exchange Online PowerShell cmdlets that are only available in the EXO V2 module are listed in the following table:
5050

5151
****
5252

@@ -61,8 +61,6 @@ The Exchange Online PowerShell cmdlets that are only available in the EXO V2 mod
6161
|[Get-EXOMailboxFolderStatistics](https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics)|[Get-MailboxFolderStatistics](https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderstatistics)|
6262
|[Get-EXOMailboxFolderPermission](https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission)|[Get-MailboxFolderPermission](https://docs.microsoft.com/powershell/module/exchange/get-mailboxfolderpermission)|
6363
|[Get-EXOMobileDeviceStatistics](https://docs.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics)|[Get-MobileDeviceStatistics](https://docs.microsoft.com/powershell/module/exchange/get-mobiledevicestatistics)|
64-
|[Get-UserBriefingConfig](https://docs.microsoft.com/powershell/module/exchange/get-userbriefingconfig)|n/a|
65-
|[Set-UserBriefingConfig](https://docs.microsoft.com/powershell/module/exchange/set-userbriefingconfig)|n/a|
6664
|
6765

6866
The connection-related cmdlets that are available in the EXO V2 module are listed in the following table:
@@ -76,6 +74,18 @@ The connection-related cmdlets that are available in the EXO V2 module are liste
7674
|[Disconnect-ExchangeOnline](https://docs.microsoft.com/powershell/module/exchange/disconnect-exchangeonline)|[Remove-PSSession](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/remove-pssession)|
7775
|
7876

77+
Miscellaneous Exchange Online cmdlets that happen to be in the EXO V2 module are listed in the following table:
78+
79+
****
80+
81+
|EXO V2 module cmdlet|Older related cmdlet|
82+
|---|---|
83+
|[Get-MyAnalyticsFeatureConfig](https://docs.microsoft.com/powershell/module/exchange/get-myanalyticsfeatureconfig)||
84+
|[Set-MyAnalyticsFeatureConfig](https://docs.microsoft.com/powershell/module/exchange/set-myanalyticsfeatureconfig)||
85+
|[Get-UserBriefingConfig](https://docs.microsoft.com/powershell/module/exchange/get-userbriefingconfig)|n/a|
86+
|[Set-UserBriefingConfig](https://docs.microsoft.com/powershell/module/exchange/set-userbriefingconfig)|n/a|
87+
|
88+
7989
## Install and maintain the EXO V2 module
8090

8191
You can download the EXO V2 module from the PowerShell gallery at <https://www.powershellgallery.com/packages/ExchangeOnlineManagement/>.
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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-myanalyticsfeatureconfig
5+
applicable: Exchange Online
6+
title: Get-MyAnalyticsFeatureConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
---
11+
12+
# Get-MyAnalyticsFeatureConfig
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
16+
17+
**Note**: This cmdlet is available in version 2.0.4-Preview3 of the EXO V2 Module.
18+
19+
Use the Get-MyAnalyticsFeatureConfig cmdlet to view the availability and feature status of MyAnalytics for the specified user.
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
Get-MyAnalyticsFeatureConfig -Identity <String> [-ResultSize <unlimited>] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
You need to be a member of the Organization Management role group (Global admins) in the destination organization to run this cmdlet.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
```powershell
36+
c:\users\vikram Get-MyAnalyticsFeatureConfig -Identity [email protected]
37+
38+
39+
PrivacyMode : opt-in
40+
IsDashboardEnabled : true
41+
IsAddInEnabled : true
42+
IsDigestEmailEnabled : false
43+
```
44+
45+
This example and the corresponding output shows the MyAnalytics configuration for the user [email protected]. MyAnalytics is available to Vikram (the PrivacyMode property value is opt-in). The only feature that's disabled is digest email messages.
46+
47+
## PARAMETERS
48+
49+
### -Identity
50+
The Identity parameter specifies the user you want to view. You identify the user by their email address.
51+
52+
```yaml
53+
Type: String
54+
Parameter Sets: (All)
55+
Aliases:
56+
Applicable: Exchange Online
57+
58+
Required: True
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -ResultSize
66+
This parameter is reserved for internal Microsoft use.
67+
68+
```yaml
69+
Type: Unlimited
70+
Parameter Sets: (All)
71+
Aliases:
72+
Applicable: Exchange Online
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### CommonParameters
82+
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).
83+
84+
## INPUTS
85+
86+
###
87+
88+
## OUTPUTS
89+
90+
###
91+
92+
## NOTES
93+
94+
## RELATED LINKS
Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
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-myanalyticsfeatureconfig
5+
applicable: Exchange Online
6+
title: Set-MyAnalyticsFeatureConfig
7+
schema: 2.0.0
8+
author: chrisda
9+
ms.author: chrisda
10+
---
11+
12+
# Set-MyAnalyticsFeatureConfig
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
16+
17+
**Note**: This cmdlet is available in version 2.0.4-Preview3 of the EXO V2 Module.
18+
19+
Use the Set-MyAnalyticsFeatureConfig cmdlet to configure the availability and features of MyAnalytics for the specified user.
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
Set-MyAnalyticsFeatureConfig -Identity <String>
27+
[-Feature <String>]
28+
[-IsEnabled <Boolean>]
29+
[-PrivacyMode <String>]
30+
[-ResultSize <Unlimited>]
31+
[<CommonParameters>]
32+
```
33+
34+
## DESCRIPTION
35+
You need to be a member of the Organization Management role group (Global admins) in the destination organization to run this cmdlet.
36+
37+
## EXAMPLES
38+
39+
### Example 1
40+
```powershell
41+
Set-MyAnalyticsFeatureConfig -Identity [email protected] -PrivacyMode opt-in
42+
```
43+
44+
This example makes MyAnalytics and all features available to Vikram.
45+
46+
### Example 2
47+
```powershell
48+
Set-MyAnalyticsFeatureConfig -Identity [email protected] -PrivacyMode opt-in -Feature digest-email -IsEnabled $false
49+
```
50+
51+
This example makes MyAnalytics available to Swathy, but disables the digest email feature.
52+
53+
### Example 3
54+
```powershell
55+
Set-MyAnalyticsFeatureConfig -Identity [email protected] -Feature digest-email -IsEnabled $false
56+
```
57+
58+
This example disables the digest email feature for Akshath.
59+
60+
## PARAMETERS
61+
62+
### -Identity
63+
The Identity parameter specifies the user you want to view. You identify the user by their email address.
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+
### -Feature
79+
The Feature parameter specifies the MyAnalytics features to enable or disable for the user. Valid values are:
80+
81+
- all (this is the default value)
82+
- add-in
83+
- dashboard
84+
- digest-email
85+
86+
To actually enable or disable a feature that's specified by this parameter, use the IsEnabled parameter in the same command.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
Accepted values: dashboard, add-in, digest-email, all
93+
Applicable: Exchange Online
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -IsEnabled
103+
The IsEnabled parameter specifies whether to enable or disable the feature that's specified by the Feature parameter. Valid values are:
104+
105+
- $true: The specified feature is enabled.
106+
- $false: The specified feature is disabled.
107+
108+
```yaml
109+
Type: Boolean
110+
Parameter Sets: (All)
111+
Aliases:
112+
Applicable: Exchange Online
113+
114+
Required: False
115+
Position: Named
116+
Default value: None
117+
Accept pipeline input: False
118+
Accept wildcard characters: False
119+
```
120+
121+
### -PrivacyMode
122+
The PrivacyMode parameter specifies whether to enable or disable MyAnalytics for the specified user. Valid values are:
123+
124+
-opt-in: MyAnalytics is enabled for the user. Use the Feature and IsEnabled parameters to enable or disable specific MyAnalytics features.
125+
-opt-out: MyAnalytics is disabled for the user.
126+
127+
```yaml
128+
Type: String
129+
Parameter Sets: (All)
130+
Aliases:
131+
Accepted values: opt-in, opt-out
132+
Applicable: Exchange Online
133+
134+
Required: False
135+
Position: Named
136+
Default value: None
137+
Accept pipeline input: False
138+
Accept wildcard characters: False
139+
```
140+
141+
### -ResultSize
142+
This parameter is reserved for internal Microsoft use.
143+
144+
```yaml
145+
Type: Unlimited
146+
Parameter Sets: (All)
147+
Aliases:
148+
Applicable: Exchange Online
149+
150+
Required: False
151+
Position: Named
152+
Default value: None
153+
Accept pipeline input: False
154+
Accept wildcard characters: False
155+
```
156+
157+
### CommonParameters
158+
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).
159+
160+
## INPUTS
161+
162+
###
163+
164+
## OUTPUTS
165+
166+
###
167+
168+
## NOTES
169+
170+
## RELATED LINKS

exchange/exchange-ps/exchange/Update-Recipient.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,29 @@ ms.reviewer:
1212
# Update-Recipient
1313

1414
## SYNOPSIS
15-
This cmdlet is available only in on-premises Exchange.
15+
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
1616

17-
Use the Update-Recipient cmdlet to add Microsoft Exchange attributes to recipient objects created by the global address list (GAL) synchronization management agent in Microsoft Forefront Identity Manager (FIM) 2010. The recipient objects you modify using this cmdlet must reside on a server running Microsoft Exchange Server 2010 or later.
17+
Use the Update-Recipient cmdlet to add Exchange attributes to recipient objects.
1818

1919
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2020

2121
## SYNTAX
2222

2323
```
24-
Update-Recipient [-Identity] <RecipientIdParameter> [-Confirm] [-Credential <PSCredential>]
25-
[-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>]
24+
Update-Recipient [-Identity] <RecipientIdParameter>
25+
[-Confirm]
26+
[-Credential <PSCredential>]
27+
[-DomainController <Fqdn>]
28+
[-WhatIf] [<CommonParameters>]
2629
```
2730

2831
## DESCRIPTION
29-
Because of mergers, acquisitions, or legal requirements, customers may need to deploy Exchange in a multiple Exchange forest topology. These deployments require the synchronization of recipient objects across disparate Active Directory forests.
30-
31-
Microsoft provides the GAL synchronization management agent for synchronizing recipient objects. The version of the GAL synchronization management agent included in Microsoft Identity Integration Server (MIIS) 2003 was designed to work with Exchange Server 2003 and relied on the Recipient Update Service. Because the Recipient Update Service is a deprecated feature and is no longer required, the new GAL synchronization management agent included in FIM 2010 is designed to function without the Recipient Update Service.
32-
33-
As part of the synchronization process, the FIM 2010 GAL synchronization management agent creates recipient objects in both Active Directory forests. After the recipients are created, the management agent uses the Update-Recipient cmdlet to add the attributes required by Microsoft Exchange to complete the provisioning of these recipients.
34-
35-
In Exchange, before you can run the Update-Recipient cmdlet to convert an Active Directory user object into an Exchange mailbox, you must stamp the user object with the following three mandatory Exchange attributes:
32+
In on-premises Exchange, before you can run the Update-Recipient cmdlet to convert an Active Directory user object into an Exchange mailbox, you must stamp the user object with the following three mandatory Exchange attributes:
3633

3734
- homeMDB
38-
3935
- mailNickname
40-
4136
- msExchHomeServerName
4237

43-
If you're using MIIS 2003, you must run various cmdlets to complete the provisioning process of the mail contacts created by the GAL synchronization management agent. The Update-Recipient cmdlet provides an alternate and more efficient method to do this. You can run the Update-Recipient cmdlet against the recipient objects created by the MIIS 2003 GAL synchronization management agent to complete the provisioning process.
44-
4538
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
4639

4740
## EXAMPLES
@@ -58,23 +51,18 @@ This example adds Exchange attributes to the mail contact that represents John S
5851
Get-MailContact -OrganizationalUnit "contoso.com/fabrikam.com Users" | Update-Recipient
5952
```
6053

61-
This example updates all contacts in a specific organizational unit (OU). This example assumes that recipients are synchronized between two forests, contoso.com and fabrikam.com, and all the synchronized recipients from the fabrikam.com domain are stored in a specific OU called fabrikam.com Users in the contoso.com domain.
54+
In on-premises Exchange, this example updates all contacts in a specific organizational unit (OU). This example assumes that recipients are synchronized between two forests, contoso.com and fabrikam.com, and all the synchronized recipients from the fabrikam.com domain are stored in a specific OU called fabrikam.com Users in the contoso.com domain.
6255

6356
## PARAMETERS
6457

6558
### -Identity
6659
The Identity parameter specifies the recipient that you want to update. You can use any value that uniquely identifies the recipient. For example:
6760

6861
- Name
69-
7062
- Alias
71-
7263
- Distinguished name (DN)
73-
7464
- Canonical DN
75-
7665
- Email address
77-
7866
- GUID
7967

8068
```yaml
@@ -129,6 +117,8 @@ Accept wildcard characters: False
129117
```
130118

131119
### -DomainController
120+
The parameter is available only in on-premises Exchange.
121+
132122
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
133123

134124
```yaml

exchange/exchange-ps/exchange/exchange.md

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

20752075
### [Get-EXORecipientPermission](Get-EXORecipientPermission.md)
20762076

2077+
### [Get-MyAnalyticsFeatureConfig](Get-MyAnalyticsFeatureConfig.md)
2078+
20772079
### [Get-UserBriefingConfig](Get-UserBriefingConfig.md)
20782080

20792081
### [Set-UserBriefingConfig](Set-UserBriefingConfig.md)
20802082

2083+
### [Set-MyAnalyticsFeatureConfig](Set-MyAnalyticsFeatureConfig.md)
2084+
20812085
## reporting Cmdlets
20822086
### [Get-CompromisedUserAggregateReport](Get-CompromisedUserAggregateReport.md)
20832087

0 commit comments

Comments
 (0)