Skip to content

Commit ee93510

Browse files
committed
Updates to MessageID parameters per Issue #2744
1 parent 0cdef6c commit ee93510

14 files changed

+96
-89
lines changed

exchange/exchange-ps/exchange/advanced-threat-protection/Get-MailDetailATPReport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Accept wildcard characters: False
197197
```
198198
199199
### -MessageId
200-
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.
200+
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>").
201201
202202
```yaml
203203
Type: MultiValuedProperty

exchange/exchange-ps/exchange/antispam-antimalware/Get-QuarantineMessage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This example presents 50 quarantined messages per page, and returns the third pa
5454

5555
### -------------------------- Example 3 --------------------------
5656
```
57-
Get-QuarantineMessage -MessageID <[email protected]>
57+
Get-QuarantineMessage -MessageID "<[email protected]>"
5858
```
5959

6060
This example returns the quarantined message with the Message-ID value \<[email protected]\>.
@@ -159,7 +159,7 @@ Accept wildcard characters: False
159159
```
160160
161161
### -MessageId
162-
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.
162+
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>").
163163
164164
```yaml
165165
Type: String

exchange/exchange-ps/exchange/client-access-servers/Set-OutlookAnywhere.md

Lines changed: 82 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,20 @@ Set-OutlookAnywhere [-Identity] <VirtualDirectoryIdParameter>
2222
[-ClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured>]
2323
[-Confirm]
2424
[-DefaultAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | MaxValidValue | Misconfigured>]
25-
[-DomainController <Fqdn>] [-ExtendedProtectionFlags <MultiValuedProperty>]
26-
[-ExtendedProtectionSPNList <MultiValuedProperty>] [-ExtendedProtectionTokenChecking <None | Allow | Require>]
27-
[-ExternalHostname <Hostname>] [-IISAuthenticationMethods <MultiValuedProperty>] [-Name <String>]
28-
[-SSLOffloading <$true | $false>] [-WhatIf] [-ExternalClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>]
25+
[-DomainController <Fqdn>]
26+
[-ExtendedProtectionFlags <MultiValuedProperty>]
27+
[-ExtendedProtectionSPNList <MultiValuedProperty>]
28+
[-ExtendedProtectionTokenChecking <None | Allow | Require>]
29+
[-ExternalClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>]
2930
[-ExternalClientsRequireSsl <$true | $false>]
31+
[-ExternalHostname <Hostname>]
32+
[-IISAuthenticationMethods <MultiValuedProperty>]
3033
[-InternalClientAuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>]
31-
[-InternalClientsRequireSsl <$true | $false>] [-InternalHostname <String>] [<CommonParameters>]
34+
[-InternalClientsRequireSsl <$true | $false>]
35+
[-InternalHostname <String>]
36+
[-Name <String>]
37+
[-SSLOffloading <$true | $false>]
38+
[-WhatIf] [<CommonParameters>]
3239
```
3340

3441
## DESCRIPTION
@@ -247,51 +254,55 @@ Accept pipeline input: False
247254
Accept wildcard characters: False
248255
```
249256
250-
### -ExternalHostname
251-
The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com.
257+
### -ExternalClientAuthenticationMethod
258+
The ExternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate external Outlook Anywhere clients. Valid values are:
259+
260+
- Basic
261+
262+
- Ntlm
263+
264+
- Negotiate (This is the default value)
265+
266+
You can't use this parameter with the DefaultAuthenticationMethods parameter.
252267
253268
```yaml
254-
Type: Hostname
269+
Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured
255270
Parameter Sets: (All)
256271
Aliases:
257-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
272+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
258273
Required: False
259274
Position: Named
260275
Default value: None
261276
Accept pipeline input: False
262277
Accept wildcard characters: False
263278
```
264279
265-
### -IISAuthenticationMethods
266-
The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are:
267-
268-
- Basic
269-
270-
- Ntlm
280+
### -ExternalClientsRequireSsl
281+
The ExternalClientsRequireSsl parameter specifies whether external Outlook Anywhere clients are required to use Secure Sockets Layer (SSL). Valid values are:
271282
272-
- Negotiate
283+
- $true: Clients connecting via Outlook Anywhere from outside the organization are required to use SSL.
273284
274-
You can specify multiple value separated by commas. By default, all values are used.
285+
- $false: Clients connecting via Outlook Anywhere from outside the organization aren't required to use SSL. This is the default value.
275286
276-
You can't use this parameter with the DefaultAuthenticationMethods parameter.
287+
The value of this parameter is related to the value of the SSLOffloading parameter.
277288
278289
```yaml
279-
Type: MultiValuedProperty
290+
Type: $true | $false
280291
Parameter Sets: (All)
281292
Aliases:
282-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
293+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
283294
Required: False
284295
Position: Named
285296
Default value: None
286297
Accept pipeline input: False
287298
Accept wildcard characters: False
288299
```
289300
290-
### -Name
291-
The Name parameter specifies the name of the Outlook Anywhere virtual directory. The default value is Rpc (Default Web Site). If the value you specify contains spaces, enclose the value in quotation marks (").
301+
### -ExternalHostname
302+
The ExternalHostname parameter specifies the external hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com.
292303
293304
```yaml
294-
Type: String
305+
Type: Hostname
295306
Parameter Sets: (All)
296307
Aliases:
297308
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
@@ -302,21 +313,21 @@ Accept pipeline input: False
302313
Accept wildcard characters: False
303314
```
304315
305-
### -SSLOffloading
306-
The SSLOffloading parameter specifies whether a network device accepts SSL connections and decrypts them before proxying the connections to the Outlook Anywhere virtual directory on the Exchange server. Valid values are:
316+
### -IISAuthenticationMethods
317+
The IISAuthenticationMethods parameter specifies the authentication method that's used on the Outlook Anywhere virtual directory in IIS. Valid values are:
307318
308-
- $true: Outlook Anywhere clients using SSL don't maintain an SSL connection along the entire network path to the Exchange server. A network device in front of the server decrypts the SSL connections and proxies the unencrypted (HTTP) client connections to the Outlook Anywhere virtual directory. The network segment where HTTP is used should be a secured network. This is the default value.
319+
- Basic
309320
310-
- $false: Outlook Anywhere clients using SSL maintain an SSL connection along the entire network path to the Exchange server. Only SSL connections are allowed to the Outlook Anywhere virtual directory.
321+
- Ntlm
311322
312-
This parameter configures the Require SSL value on the Outlook Anywhere virtual directory. When you set this parameter to $true, Require SSL is disabled. When you set this parameter to $fase, Require SSL is enabled. However, it may take several minutes before the change is visible in IIS Manager.
323+
- Negotiate
313324
314-
You need to use the value $true for this parameter if you don't require SSL connections for internal or external Outlook Anywhere clients.
325+
You can specify multiple value separated by commas. By default, all values are used.
315326
316-
The value of this parameter is related to the values of the ExternalClientsRequireSsl and InternalClientsRequireSsl parameters.
327+
You can't use this parameter with the DefaultAuthenticationMethods parameter.
317328
318329
```yaml
319-
Type: $true | $false
330+
Type: MultiValuedProperty
320331
Parameter Sets: (All)
321332
Aliases:
322333
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
@@ -327,29 +338,14 @@ Accept pipeline input: False
327338
Accept wildcard characters: False
328339
```
329340
330-
### -WhatIf
331-
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.
332-
333-
```yaml
334-
Type: SwitchParameter
335-
Parameter Sets: (All)
336-
Aliases: wi
337-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
338-
Required: False
339-
Position: Named
340-
Default value: None
341-
Accept pipeline input: False
342-
Accept wildcard characters: False
343-
```
344-
345-
### -ExternalClientAuthenticationMethod
346-
The ExternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate external Outlook Anywhere clients. Valid values are:
341+
### -InternalClientAuthenticationMethod
342+
The InternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate internal Outlook Anywhere clients. Valid values are:
347343
348344
- Basic
349345
350-
- Ntlm
346+
- Ntlm (This is the default value)
351347
352-
- Negotiate (This is the default value)
348+
- Negotiate
353349
354350
You can't use this parameter with the DefaultAuthenticationMethods parameter.
355351
@@ -365,12 +361,12 @@ Accept pipeline input: False
365361
Accept wildcard characters: False
366362
```
367363
368-
### -ExternalClientsRequireSsl
369-
The ExternalClientsRequireSsl parameter specifies whether external Outlook Anywhere clients are required to use Secure Sockets Layer (SSL). Valid values are:
364+
### -InternalClientsRequireSsl
365+
The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are:
370366
371-
- $true: Clients connecting via Outlook Anywhere from outside the organization are required to use SSL.
367+
- $true: Clients connecting via Outlook Anywhere from inside the organization are required to use SSL.
372368
373-
- $false: Clients connecting via Outlook Anywhere from outside the organization aren't required to use SSL. This is the default value.
369+
- $false: Clients connecting via Outlook Anywhere from inside the organization aren't required to use SSL. This is the default value.
374370
375371
The value of this parameter is related to the value of the SSLOffloading parameter.
376372
@@ -386,58 +382,69 @@ Accept pipeline input: False
386382
Accept wildcard characters: False
387383
```
388384
389-
### -InternalClientAuthenticationMethod
390-
The InternalClientAuthenticationMethod parameter specifies the authentication method that's used to authenticate internal Outlook Anywhere clients. Valid values are:
391-
392-
- Basic
393-
394-
- Ntlm (This is the default value)
385+
### -InternalHostname
386+
The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com.
395387
396-
- Negotiate
388+
```yaml
389+
Type: String
390+
Parameter Sets: (All)
391+
Aliases:
392+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
393+
Required: False
394+
Position: Named
395+
Default value: None
396+
Accept pipeline input: False
397+
Accept wildcard characters: False
398+
```
397399
398-
You can't use this parameter with the DefaultAuthenticationMethods parameter.
400+
### -Name
401+
The Name parameter specifies the name of the Outlook Anywhere virtual directory. The default value is Rpc (Default Web Site). If the value you specify contains spaces, enclose the value in quotation marks (").
399402
400403
```yaml
401-
Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured
404+
Type: String
402405
Parameter Sets: (All)
403406
Aliases:
404-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
407+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
405408
Required: False
406409
Position: Named
407410
Default value: None
408411
Accept pipeline input: False
409412
Accept wildcard characters: False
410413
```
411414
412-
### -InternalClientsRequireSsl
413-
The InternalClientsRequireSsl parameter specifies whether internal Outlook Anywhere clients are required to use SSL. Valid values are:
415+
### -SSLOffloading
416+
The SSLOffloading parameter specifies whether a network device accepts SSL connections and decrypts them before proxying the connections to the Outlook Anywhere virtual directory on the Exchange server. Valid values are:
414417
415-
- $true: Clients connecting via Outlook Anywhere from inside the organization are required to use SSL.
418+
- $true: Outlook Anywhere clients using SSL don't maintain an SSL connection along the entire network path to the Exchange server. A network device in front of the server decrypts the SSL connections and proxies the unencrypted (HTTP) client connections to the Outlook Anywhere virtual directory. The network segment where HTTP is used should be a secured network. This is the default value.
416419
417-
- $false: Clients connecting via Outlook Anywhere from inside the organization aren't required to use SSL. This is the default value.
420+
- $false: Outlook Anywhere clients using SSL maintain an SSL connection along the entire network path to the Exchange server. Only SSL connections are allowed to the Outlook Anywhere virtual directory.
418421
419-
The value of this parameter is related to the value of the SSLOffloading parameter.
422+
This parameter configures the Require SSL value on the Outlook Anywhere virtual directory. When you set this parameter to $true, Require SSL is disabled. When you set this parameter to $fase, Require SSL is enabled. However, it may take several minutes before the change is visible in IIS Manager.
423+
424+
You need to use the value $true for this parameter if you don't require SSL connections for internal or external Outlook Anywhere clients.
425+
426+
The value of this parameter is related to the values of the ExternalClientsRequireSsl and InternalClientsRequireSsl parameters.
420427
421428
```yaml
422429
Type: $true | $false
423430
Parameter Sets: (All)
424431
Aliases:
425-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
432+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
426433
Required: False
427434
Position: Named
428435
Default value: None
429436
Accept pipeline input: False
430437
Accept wildcard characters: False
431438
```
432439
433-
### -InternalHostname
434-
The InternalHostname parameter specifies the internal hostname for the Outlook Anywhere virtual directory. For example, mail.contoso.com.
440+
### -WhatIf
441+
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.
435442
436443
```yaml
437-
Type: String
444+
Type: SwitchParameter
438445
Parameter Sets: (All)
439-
Aliases:
440-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
446+
Aliases: wi
447+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
441448
Required: False
442449
Position: Named
443450
Default value: None

exchange/exchange-ps/exchange/encryption-and-certificates/Get-OMEMessageStatus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This example returns the encryption revocation status for the specified message.
3838
## PARAMETERS
3939

4040
### -MessageId
41-
The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.
41+
The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>").
4242

4343
You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Office 365 Security & Compliance Center.
4444

exchange/exchange-ps/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This example revokes encryption for the specified message.
4040
## PARAMETERS
4141

4242
### -MessageId
43-
The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.
43+
The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>").
4444

4545
You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Office 365 Security & Compliance Center.
4646

exchange/exchange-ps/exchange/mail-flow/Add-ResubmitRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Accept wildcard characters: False
143143
```
144144
145145
### -MessageId
146-
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string. This may include angle brackets.
146+
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "<[email protected]>").
147147
148148
```yaml
149149
Type: String

0 commit comments

Comments
 (0)