Read-SqlXEvent
Считывает XEvents SQL Server из XEL-файла или динамического сеанса XEvent SQL.
Синтаксис
Read-SqlXEvent
[-FileName] <String>
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Read-SqlXEvent
-ConnectionString <String>
-SessionName <String>
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Описание
Read-SqlXEvent считывает XEvents SQL Server из файла или динамического сеанса XEvent SQL. Сеансы XEvent создаются API CREATE EVENT SESSION Transact-SQL. Файлы SQL XEvent обычно имеют . Расширения XEL или .sqlaudit и содержат поток XEvents. Структура XEvents определяется в конфигурации сеанса. Динамические потоки SQL доступны через протокол TDS SQL и требуют проверки подлинности на сервере, который создал их.
New in v22: if you are using the -ConnectionString parameter, you may get an error like "The certificate chain was issued by an authority that is not trusted." This is because the new SQL driver changed its default to something more secure. Either make sure you configure your server properly, or install/trust the certificate; alternatively (not recommended), you can pass Encrypt=Optional or TrustServerCertificate=true in the connection string to go back to the behavior that existed in v21 of the module.
Примеры
Пример 1. Чтение и анализ файла sqlaudit. Каждый возвращаемый объект будет содержать все сведения из одной записи аудита.
Read-SqlXEvent -FileName C:\audits\Audit-20190529-132659.sqlaudit
# The output would look like this:
#
# Name : audit_event
# UUID : c6479a6f-f1bd-4759-9881-fcb493821aff
# Timestamp : 6/13/2019 7:49:42 AM +00:00
# Fields : {[audit_schema_version, 1], [event_time, 6/13/2019 7:49:42 AM +00:00], [sequence_number, 1], [action_id,
# 1129534785]...}
# Actions : {}
#
# Name : audit_event
# UUID : c6479a6f-f1bd-4759-9881-fcb493821aff
# Timestamp : 6/13/2019 12:42:28 PM +00:00
# Fields : {[audit_schema_version, 1], [event_time, 6/13/2019 12:42:28 PM +00:00], [sequence_number, 1], [action_id,
# 1129534785]...}
# Actions : {}
# ...Пример 2. Чтение и анализ динамического потока XEvents из SQL Server, работающего на том же компьютере, подключенном к проверке подлинности Windows. Каждый возвращаемый объект будет содержать все сведения из одной записи XEvent.
Read-SQLXEvent -ConnectionString "Server=.;Database=master;Trusted_Connection=True" -SessionName telemetry_xevents
# The output would look like this:
#
# Name : auto_stats
# UUID : 9237e17a-a73d-4832-8936-f319e19e219b
# Timestamp : 11/14/2022 5:31:12 AM +00:00
# Fields : {[database_id, 1], [object_id, 74], [index_id, 1], [job_id, 0]…}
# Actions : {}
#
# Name : auto_stats
# UUID : 9237e17a-a73d-4832-8936-f319e19e219b
# Timestamp : 11/14/2022 5:31:12 AM +00:00
# Fields : {[database_id, 1], [object_id, 74], [index_id, 17], [job_id, 0]…}
# Actions : {}
# ...Параметры
-ConnectionString
Строка подключения SQL Server.
| Тип: | String |
| Position: | Named |
| Default value: | None |
| Обязательно: | True |
| Принять входные данные конвейера: | False |
| Принять подстановочные знаки: | False |
-FileName
Имя файла XEvent для чтения.
| Тип: | String |
| Position: | 0 |
| Default value: | None |
| Обязательно: | True |
| Принять входные данные конвейера: | True |
| Принять подстановочные знаки: | False |
-ProgressAction
Определяет, как PowerShell реагирует на обновления хода выполнения, созданные скриптом, командлетом или поставщиком, например индикаторами хода выполнения, созданными командлетом Write-Progress. Командлет Write-Progress создает индикаторы хода выполнения, показывающие состояние команды.
| Тип: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Обязательно: | False |
| Принять входные данные конвейера: | False |
| Принять подстановочные знаки: | False |
-SessionName
Имя сеанса XEvent SQL Server, определенное параметром CREATE EVENT SESSION Transact-SQL.
| Тип: | String |
| Position: | Named |
| Default value: | None |
| Обязательно: | True |
| Принять входные данные конвейера: | False |
| Принять подстановочные знаки: | False |
Входные данные
System.String
Выходные данные
Microsoft.SqlServer.XEvent.XELite.IXEvent