---
title: "Read-XEvent"
description: " Read-XEvent [-FileName <string>] [-ConnectionString <string>] [-SessionName <string>] [<CommonParameters>] "
url: "https://dbatools.io/Read-XEvent/"
availability: "Windows, Linux, macOS"
source: "https://github.com/dataplat/dbatools/blob/master/public/Read-XEvent.ps1"
last_updated: "2024-01-01"
---

# Read-XEvent

## Synopsis


  
Read-XEvent [-FileName <string>] [-ConnectionString <string>] [-SessionName <string>] [<CommonParameters>]
  

## Description

## Syntax

```powershell
Read-XEventsyntaxItem                                                                                             ----------                                                                                             {@{name=

Read-XEvent; CommonParameters=True; WorkflowCommonParameters=False; parameter=System.Object[]}}

```

## Examples

### Optional Parameters

##### -ConnectionString

| Property | Value |
| --- | --- |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -FileName

| Property | Value |
| --- | --- |
| Alias | FullName |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |  |

##### -SessionName

| Property | Value |
| --- | --- |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

---

Part of [dbatools](https://dbatools.io/), a free and open source PowerShell module for SQL Server administration. Full command index: https://dbatools.io/commands/