Skip to content

Commit 5ca779f

Browse files
committed
Merge branch 'main' into CBA_SCC-chrisda
2 parents b0dd424 + f04bca9 commit 5ca779f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+453
-449
lines changed

exchange/docs-conceptual/exchange-management-shell.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ The Exchange Management Shell also provides a robust and flexible scripting plat
2121

2222
To start using the Exchange Management Shell immediately, see the [Exchange Management Shell documentation](#exchange-management-shell-documentation) section later in this article.
2323

24+
> [!NOTE]
25+
> There is no Microsoft-provided module in the PowerShell Gallery for Exchange Server PowerShell. Instead, to use PowerShell in Exchange Server, you have the following options:
26+
>
27+
> - Use the Exchange Management Shell on an Exchange server or that you've installed locally on your own computer using a **Management tools** only installation of Exchange server. For more information, see [Install the Exchange Server Management Tools](/Exchange/plan-and-deploy/post-installation-tasks/install-management-tools) and [Open the Exchange Management Shell](open-the-exchange-management-shell.md).
28+
> - Use remote PowerShell from a Windows PowerShell session. For more information, see [Connect to Exchange servers using remote PowerShell](connect-to-exchange-servers-using-remote-powershell.md).
29+
2430
## How the Exchange Management Shell works on all Exchange server roles except Edge Transport
2531

2632
Whether you use the Exchange Management Shell on a local Exchange server or on an Exchange server that's located across the country, remote PowerShell does the work.

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

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -223,29 +223,43 @@ The EXO V2 module is supported in the following versions of Windows:
223223
> [!NOTE]
224224
> As described [earlier in this article](#updates-for-version-206), v2.0.6 of the EXO V2 module does not require Basic authentication in WinRM for many cmdlets.
225225
>
226-
> You must temporarily enable WinRM to run the following commands. You can enable WinRM by running the command: `winrm quickconfig`.
226+
> You must temporarily enable WinRM to run the following winrm commands. You can enable WinRM by running the command: `winrm quickconfig`.
227227
228-
To verify that Basic authentication is enabled for WinRM, run this command **in a Command Prompt** (not in PowerShell):
228+
To verify that Basic authentication is enabled for WinRM, run the following command in a **Command Prompt** or **Windows PowerShell**:
229229

230-
```dos
230+
```DOS
231231
winrm get winrm/config/client/auth
232232
```
233233

234-
If you don't see the value `Basic = true`, you need to run this command **in a Command Prompt** (not in PowerShell) to enable Basic authentication for WinRM:
234+
If you don't see the value `Basic = true`, you need to run **one** of the following commands to enable Basic authentication for WinRM:
235235

236-
```dos
237-
winrm set winrm/config/client/auth @{Basic="true"}
238-
```
236+
- **In a Command Prompt**:
237+
238+
```DOS
239+
winrm set winrm/config/client/auth @{Basic="true"}
240+
```
239241
240-
**Note**: If you'd rather run the command in PowerShell, enclose this part of the command in quotation marks: `'@{Basic="true"}'`.
242+
- **In Windows PowerShell**:
241243
242-
If Basic authentication for WinRM is disabled, you'll get this error when you try to connect:
244+
```DOS
245+
winrm set winrm/config/client/auth '@{Basic="true"}'
246+
```
247+
248+
- **In Windows PowerShell to modify the registry**:
249+
250+
```PowerShell
251+
Set-ItemProperty -Path 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WinRM\Client' -Name 'AllowBasic' -Type DWord -Value '1'
252+
```
253+
254+
If Basic authentication for WinRM is disabled, you'll get one of the following errors when you try to connect:
243255
244256
> The WinRM client cannot process the request. Basic authentication is currently disabled in the client configuration. Change the client configuration and try the request again.
245257
258+
> Create Powershell Session is failed using OAuth.
259+
246260
> [!TIP]
247261
> Having problems? Ask for help in the Exchange forums. Visit the forums at: [Exchange Online](https://go.microsoft.com/fwlink/p/?linkId=267542), or [Exchange Online Protection](https://go.microsoft.com/fwlink/p/?linkId=285351).
248-
262+
249263
### Install the EXO V2 module
250264
251265
To install the EXO V2 module for the first time, complete the following steps:

exchange/exchange-ps/exchange/Add-MailboxPermission.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ Add-MailboxPermission [[-Identity] <MailboxIdParameter>] -Instance <MailboxAcePr
6262
```
6363

6464
## DESCRIPTION
65-
This cmdlet updates the mailbox object that's specified by the Identity parameter.
65+
66+
> [!NOTE]
67+
> You can use this cmdlet to add a maximum of 500 permission entries (ACEs) to a mailbox. To grant permissions to more than 500 users, use security groups instead of individual users for the User parameter. Security groups contain many members, but only count as one entry.
6668
6769
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).
6870

exchange/exchange-ps/exchange/Get-ComplianceSearchAction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ This example shows a summary list of all compliance search actions.
8484

8585
### Example 2
8686
```powershell
87-
Get-ComplianceSearchAction -Identity "Case 1234\_Preview" | Format-List
87+
Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List
8888
```
8989

90-
This example shows details about the compliance search action named "Case 1234\_Preview"
90+
This example shows details about the compliance search action named "Case 1234_Preview"
9191

9292
## PARAMETERS
9393

9494
### -Identity
9595
The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example:
9696

97-
- Name: The compliance search action name uses the syntax `"Compliance Search Name\_Action"`. For example, `"Case 1234\_Preview"`.
97+
- Name: The compliance search action name uses the syntax `"Compliance Search Name_Action"`. For example, `"Case 1234_Preview"`.
9898
- JobRunId (GUID)
9999

100100
You can't use this parameter with the Export, Preview, or Purge parameters.

exchange/exchange-ps/exchange/Get-RMSTrustedPublishingDomain.md

Lines changed: 13 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ This cmdlet is available only in the cloud-based service.
1616

1717
**Note**: This cmdlet has been deprecated and is no longer used.
1818

19-
Use the Get-RMSTrustedPublishingDomain cmdlet to view the settings of an existing trusted publishing domain (TPD) in your organization.
20-
21-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
22-
2319
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2420

2521
## SYNTAX
@@ -31,54 +27,48 @@ Get-RMSTrustedPublishingDomain [[-Identity] <RmsTrustedPublishingDomainIdParamet
3127
```
3228

3329
## DESCRIPTION
34-
A trusted publishing domain contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages.
30+
This cmdlet has been deprecated and is no longer used.
3531

3632
## EXAMPLES
3733

3834
### Example 1
3935
```powershell
40-
Get-RMSTrustedPublishingDomain | Format-List
36+
Get-RMSTrustedPublishingDomain
4137
```
4238

43-
This example lists all the trusted publishing domains that are configured in your organization and shows detailed information for each trusted publishing domain.
39+
This cmdlet has been deprecated and is no longer used.
4440

4541
## PARAMETERS
4642

47-
### -Default
48-
The Default switch filters the results by the default trusted publishing domain. You don't need to specify a value with this switch.
49-
50-
The default trusted publishing domain displays RMS templates and provides rights protection to all new content. There can be only one default trusted publishing domain in an organization.
43+
### -Identity
44+
This cmdlet has been deprecated and is no longer used.
5145

5246
```yaml
53-
Type: SwitchParameter
47+
Type: RmsTrustedPublishingDomainIdParameter
5448
Parameter Sets: (All)
5549
Aliases:
5650
Applicable: Exchange Online
5751

5852
Required: False
59-
Position: Named
53+
Position: 1
6054
Default value: None
61-
Accept pipeline input: False
55+
Accept pipeline input: True
6256
Accept wildcard characters: False
6357
```
6458
65-
### -Identity
66-
The Identity parameter specifies the trusted publishing domain. You can use any value that uniquely identifies the trusted publishing domain, for example:
67-
68-
- Name
69-
- Distinguished name (DN)
70-
- GUID
59+
### -Default
60+
This cmdlet has been deprecated and is no longer used.
7161
7262
```yaml
73-
Type: RmsTrustedPublishingDomainIdParameter
63+
Type: SwitchParameter
7464
Parameter Sets: (All)
7565
Aliases:
7666
Applicable: Exchange Online
7767

7868
Required: False
79-
Position: 1
69+
Position: Named
8070
Default value: None
81-
Accept pipeline input: True
71+
Accept pipeline input: False
8272
Accept wildcard characters: False
8373
```
8474

exchange/exchange-ps/exchange/Import-RMSTrustedPublishingDomain.md

Lines changed: 29 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ This cmdlet is available only in the cloud-based service.
1616

1717
**Note**: This cmdlet has been deprecated and is no longer used.
1818

19-
Use the Import-RMSTrustedPublishingDomain cmdlet to import a trusted publishing domain (TPD) from an on-premises server running Active Directory Rights Management Services (AD RMS) or from RMS Online into your cloud-based organization.
20-
21-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
22-
2319
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2420

2521
## SYNTAX
@@ -66,55 +62,41 @@ Import-RMSTrustedPublishingDomain [-Name] <String>
6662
```
6763

6864
## DESCRIPTION
69-
A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. After you export the TPD from an on-premises AD RMS server to an XML file, you can import the XML file into your cloud-based organization.
70-
71-
If the InternalLicensingEnabled parameter value is $true on the Set-IRMConfiguration cmdlet, all TPDs require a private key. If the InternalLicensingEnabled parameter value is $false, TPDs don't require a private key. However, the only RMS feature available to the organization is Outlook protection rules. Typically, TPDs without private keys are created when the AD RMS server uses a hardware-based cryptographic service provider (CSP) or a custom CSP.
72-
73-
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).
65+
This cmdlet has been deprecated and is no longer used.
7466

7567
## EXAMPLES
7668

7769
### Example 1
7870
```powershell
79-
Import-RMSTrustedPublishingDomain -Name "Contoso TPD" -FileData ([System.IO.File]::ReadAllBytes('C:\My Documents\Contoso.xml')) -Password (ConvertTo-SecureString -String 'Pa$$word1' -AstPlainText -Force) -ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -IntranetLicensingUrl https://RMS01/_wmcs/licensing
71+
Import-RMSTrustedPublishingDomain
8072
```
8173

82-
This example imports a TPD from an AD RMS server into a cloud-based organization. The TPD uses the following values:
83-
84-
- Path to exported XML file: C:\\My Documents\\Contoso.xml
85-
- Password of exported XML file: Pa$$word1
86-
- External licensing URL: `https://rms.contoso.com/_wmcs/licensing`
87-
- Internal licensing URL: `https://RMS01/_wmcs/licensing`
88-
- TPD name: Contoso TPD
74+
This cmdlet has been deprecated and is no longer used.
8975

9076
## PARAMETERS
9177

92-
### -ExtranetLicensingUrl
93-
The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content.
94-
95-
By default, the value of the ExtranetLicensingUrl parameter is `https://<FQDN>/_wmcs/licensing`.
78+
### -Name
79+
This cmdlet has been deprecated and is no longer used.
9680

9781
```yaml
98-
Type: Uri
99-
Parameter Sets: IntranetLicensingUrl, ImportFromFile
82+
Type: String
83+
Parameter Sets: (All)
10084
Aliases:
10185
Applicable: Exchange Online
10286

10387
Required: True
104-
Position: Named
88+
Position: 1
10589
Default value: None
10690
Accept pipeline input: False
10791
Accept wildcard characters: False
10892
```
10993
110-
### -FileData
111-
The FileData parameter specifies the XML file you want to import. The XML file contains the TPD you exported from the on-premises AD RMS server.
112-
113-
A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('<Path>\<FileName>'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('<Path>\<FileName>')`) and use the variable as the parameter value (`$data`).
94+
### -ExtranetLicensingUrl
95+
This cmdlet has been deprecated and is no longer used.
11496
11597
```yaml
116-
Type: Byte[]
117-
Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates
98+
Type: Uri
99+
Parameter Sets: IntranetLicensingUrl, ImportFromFile
118100
Aliases:
119101
Applicable: Exchange Online
120102

@@ -125,14 +107,12 @@ Accept pipeline input: False
125107
Accept wildcard characters: False
126108
```
127109
128-
### -IntranetLicensingUrl
129-
The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content.
130-
131-
By default, the value of the IntranetLicensingUrl parameter is `https://<server name>/_wmcs/licensing`.
110+
### -FileData
111+
This cmdlet has been deprecated and is no longer used.
132112
133113
```yaml
134-
Type: Uri
135-
Parameter Sets: IntranetLicensingUrl, ImportFromFile
114+
Type: Byte[]
115+
Parameter Sets: IntranetLicensingUrl, ImportFromFile, RefreshTemplates
136116
Aliases:
137117
Applicable: Exchange Online
138118

@@ -143,26 +123,24 @@ Accept pipeline input: False
143123
Accept wildcard characters: False
144124
```
145125
146-
### -Name
147-
The Name parameter specifies the name of the TPD. If you use the RefreshTemplates switch, the value must match the name of the previously imported TPD.
126+
### -IntranetLicensingUrl
127+
This cmdlet has been deprecated and is no longer used.
148128
149129
```yaml
150-
Type: String
151-
Parameter Sets: (All)
130+
Type: Uri
131+
Parameter Sets: IntranetLicensingUrl, ImportFromFile
152132
Aliases:
153133
Applicable: Exchange Online
154134

155135
Required: True
156-
Position: 1
136+
Position: Named
157137
Default value: None
158138
Accept pipeline input: False
159139
Accept wildcard characters: False
160140
```
161141
162142
### -Password
163-
The Password parameter specifies the password of the TPD that you want to import. The password value must match the password in the XML file when you exported the TPD from the on-premises AD RMS server.
164-
165-
This parameter uses the syntax `(ConvertTo-SecureString -String '<password>' -AsPlainText -Force)`. Or, before you run this command, store the password as a variable (for example, `$password = Read-Host "Enter password" -AsSecureString`), and then use the variable name (`$password`) for this parameter.
143+
This cmdlet has been deprecated and is no longer used.
166144
167145
```yaml
168146
Type: SecureString
@@ -178,7 +156,7 @@ Accept wildcard characters: False
178156
```
179157
180158
### -RMSOnline
181-
The RMSOnline switch specifies that the TPD is imported from RMS Online. You don't need to specify a value with this switch.
159+
This cmdlet has been deprecated and is no longer used.
182160
183161
```yaml
184162
Type: SwitchParameter
@@ -194,10 +172,7 @@ Accept wildcard characters: False
194172
```
195173
196174
### -Confirm
197-
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
198-
199-
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
200-
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
175+
This cmdlet has been deprecated and is no longer used.
201176
202177
```yaml
203178
Type: SwitchParameter
@@ -213,11 +188,7 @@ Accept wildcard characters: False
213188
```
214189
215190
### -Default
216-
The Default switch specifies that this is the default TPD. You don't need to specify a value with this switch.
217-
218-
The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization.
219-
220-
The first TPD you import into your organization is automatically set as the default.
191+
This cmdlet has been deprecated and is no longer used.
221192
222193
```yaml
223194
Type: SwitchParameter
@@ -233,9 +204,7 @@ Accept wildcard characters: False
233204
```
234205
235206
### -ExtranetCertificationUrl
236-
The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content.
237-
238-
By default, the value of the ExtranetCertificationUrl parameter is `https://<FQDN>/_wmcs/certification/servercertification.asmx`.
207+
This cmdlet has been deprecated and is no longer used.
239208
240209
```yaml
241210
Type: Uri
@@ -251,9 +220,7 @@ Accept wildcard characters: False
251220
```
252221
253222
### -IntranetCertificationUrl
254-
The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content.
255-
256-
By default, the value of the IntranetCertificationUrl parameter is `https://<server name>/_wmcs/certification/servercertification.asmx`.
223+
This cmdlet has been deprecated and is no longer used.
257224
258225
```yaml
259226
Type: Uri
@@ -269,14 +236,7 @@ Accept wildcard characters: False
269236
```
270237
271238
### -RefreshTemplates
272-
The RefreshTemplates switch specifies whether to update the RMS templates in a previously imported TPD. You don't need to specify a value with this switch.
273-
274-
When you add, modify, or remove RMS templates in a TPD on the AD RMS server, you export the updated TPD to a new XML file, and import the new XML file in your cloud-based organization. The RefreshTemplates switch uses the following rules:
275-
276-
- Only the FileData, Password, and Name parameters are required. The value of the Name parameter must match the name of the previously imported TPD.
277-
- If the new XML file doesn't contain an RMS template that was defined in the previously imported TPD, the RMS template is removed from the cloud-based organization.
278-
- If the new XML file contains an updated RMS template that was defined in the previously imported TPD, the RMS template settings are updated in the cloud-based organization. However, the RMS template isn't changed from Archived to Distributed or vice versa.
279-
- If the new XML file contains an RMS template that wasn't imported in the original TPD, the RMS template is added to the cloud-based organization in the Archived state. To make the new RMS template usable, you must change its state from Archived to Distributed using the Set-RMSTemplate cmdlet.
239+
This cmdlet has been deprecated and is no longer used.
280240
281241
```yaml
282242
Type: SwitchParameter
@@ -292,7 +252,7 @@ Accept wildcard characters: False
292252
```
293253
294254
### -WhatIf
295-
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
255+
This cmdlet has been deprecated and is no longer used.
296256
297257
```yaml
298258
Type: SwitchParameter

0 commit comments

Comments
 (0)