Skip to content

Commit 17d2aaf

Browse files
chrisdachrisda
authored
Merge branch 'main' into chrisda
2 parents f070ad2 + 963fb63 commit 17d2aaf

File tree

2 files changed

+532
-0
lines changed

2 files changed

+532
-0
lines changed

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

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-messagetracedetailv2
4+
applicable: Exchange Online
5+
title: Get-MessageTraceDetailV2
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-MessageTraceDetailV2
13+
14+
## SYNOPSIS
15+
16+
## SYNTAX
17+
18+
```
19+
Get-MessageTraceDetailV2 [-MessageTraceId] <Guid> [-RecipientAddress] <String>
20+
[[-Action] <MultiValuedProperty>]
21+
[[-EndDate] <System.DateTime>]
22+
[[-Event] <MultiValuedProperty>]
23+
[[-MessageId] <String>]
24+
[[-SenderAddress] <String>]
25+
[[-StartDate] <System.DateTime>]
26+
[<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
You can use this cmdlet to search message data for the last 90 days. You can only query 10 days worth of data per query. If you enter a timeframe that's older than 90 days, you receive an error and the command will return no results.
31+
32+
Throttling limit: A maximum of 100 query requests will be accepted within 5 minutes running window. Throttling is automatically not applied if the request rate is lower than 100 requests in the past 5 minutes
33+
34+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
Get-MessageTraceDetailV2 -MessageTraceId ae5c1219-4c90-41bf-fef5-08d837917e7c -RecipientAddress [email protected]
41+
```
42+
43+
This example retrieves detailed message trace information for messages with the message trace ID value ae5c1219-4c90-41bf-fef5-08d837917e7c that were received by `[email protected]`.
44+
45+
### Example 2
46+
```powershell
47+
Get-MessageTraceV2 -MessageTraceId 2bbad36aa4674c7ba82f4b307fff549f -SenderAddress [email protected] -StartDate 06/13/2025 -EndDate 06/15/2025 | Get-MessageTraceDetailV2
48+
```
49+
50+
This example uses the Get-MessageTrace cmdlet to retrieve message trace information for messages with the Exchange Network Message ID value 2bbad36aa4674c7ba82f4b307fff549f sent by `[email protected]` between June 13, 2025 and June 15, 2025, and pipelines the results to the Get-MessageTraceDetailV2 cmdlet.
51+
52+
## PARAMETERS
53+
54+
### -MessageTraceId
55+
The MessageTraceId parameter filters the results by the message trace ID value of the message. This GUID value is generated for every message that's processed by the system (for example, c20e0f7a-f06b-41df-fe33-08d9da155ac1).
56+
57+
```yaml
58+
Type: Guid
59+
Parameter Sets: (All)
60+
Aliases:
61+
Applicable: Exchange Online
62+
63+
Required: True
64+
Position: 5
65+
Default value: None
66+
Accept pipeline input: True (ByPropertyName)
67+
Accept wildcard characters: False
68+
```
69+
70+
### -RecipientAddress
71+
The RecipientAddress parameter filters the results by the recipient's email address.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
Applicable: Exchange Online
78+
79+
Required: True
80+
Position: 6
81+
Default value: None
82+
Accept pipeline input: True (ByPropertyName)
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Action
87+
The Action parameter filters the report by the action taken on messages. To view the complete list of valid values for this parameter, run the command: `Get-MailFilterListReport -SelectionTarget Actions`. The action you specify must correspond to the report type. For example, you can only specify malware filter actions for malware reports.
88+
89+
You can specify multiple values separated by commas.
90+
91+
```yaml
92+
Type: MultiValuedProperty
93+
Parameter Sets: (All)
94+
Aliases:
95+
Applicable: Exchange Online
96+
97+
Required: False
98+
Position: 1
99+
Default value: None
100+
Accept pipeline input: False
101+
Accept wildcard characters: False
102+
```
103+
104+
### -EndDate
105+
The EndDate parameter specifies the end date of the date range.
106+
107+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM".
108+
109+
If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned.
110+
111+
```yaml
112+
Type: System.DateTime
113+
Parameter Sets: (All)
114+
Aliases:
115+
Applicable: Exchange Online
116+
117+
Required: False
118+
Position: 2
119+
Default value: None
120+
Accept pipeline input: True (ByPropertyName)
121+
Accept wildcard characters: False
122+
```
123+
124+
### -Event
125+
The Event parameter filters the report by the message event. The following are examples of common events:
126+
127+
- RECEIVE: The message was received by the service.
128+
- SEND: The message was sent by the service.
129+
- FAIL: The message failed to be delivered.
130+
- DELIVER: The message was delivered to a mailbox.
131+
- EXPAND: The message was sent to a distribution group that was expanded.
132+
- TRANSFER: Recipients were moved to a bifurcated message because of content conversion, message recipient limits, or agents.
133+
- DEFER: The message delivery was postponed and may be re-attempted later.
134+
135+
You can specify multiple values separated by commas.
136+
137+
```yaml
138+
Type: MultiValuedProperty
139+
Parameter Sets: (All)
140+
Aliases:
141+
Applicable: Exchange Online
142+
143+
Required: False
144+
Position: 3
145+
Default value: None
146+
Accept pipeline input: False
147+
Accept wildcard characters: False
148+
```
149+
150+
### -MessageId
151+
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>").
152+
153+
```yaml
154+
Type: String
155+
Parameter Sets: (All)
156+
Aliases:
157+
Applicable: Exchange Online
158+
159+
Required: False
160+
Position: 4
161+
Default value: None
162+
Accept pipeline input: True (ByPropertyName)
163+
Accept wildcard characters: False
164+
```
165+
166+
### -SenderAddress
167+
The SenderAddress parameter filters the results by the sender's email address. You can specify multiple values separated by commas.
168+
169+
```yaml
170+
Type: String
171+
Parameter Sets: (All)
172+
Aliases:
173+
Applicable: Exchange Online
174+
175+
Required: False
176+
Position: 7
177+
Default value: None
178+
Accept pipeline input: True (ByPropertyName)
179+
Accept wildcard characters: False
180+
```
181+
182+
### -StartDate
183+
The StartDate parameter specifies the start date of the date range.
184+
185+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2025 to specify September 1, 2025. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2025 5:00 PM".
186+
187+
If don't use the StartDate and EndDate parameters, only data from the last 48 hours is returned.
188+
189+
```yaml
190+
Type: System.DateTime
191+
Parameter Sets: (All)
192+
Aliases:
193+
Applicable: Exchange Online
194+
195+
Required: False
196+
Position: 8
197+
Default value: None
198+
Accept pipeline input: True (ByPropertyName)
199+
Accept wildcard characters: False
200+
```
201+
202+
### CommonParameters
203+
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).
204+
205+
## INPUTS
206+
207+
## OUTPUTS
208+
209+
## NOTES
210+
211+
## RELATED LINKS

0 commit comments

Comments
 (0)