Read-SqlXEvent
Membaca SQL Server XEvents dari file XEL atau sesi XEvent SQL langsung.
Sintaks
ByFile (Default)
Read-SqlXEvent
[-FileName] <String>
[<CommonParameters>]
ByLiveData
Read-SqlXEvent
-ConnectionString <String>
-SessionName <String>
[<CommonParameters>]
Deskripsi
Read-SqlXEvent membaca SQL Server XEvents dari file atau sesi SQL XEvent langsung. Sesi XEvent dibuat oleh CREATE EVENT SESSION Transact-SQL API. File SQL XEvent biasanya memiliki . Ekstensi XEL atau .sqlaudit dan berisi aliran XEvents. Struktur XEvents ditentukan dalam konfigurasi sesi. Streaming langsung SQL tersedia melalui protokol SQL TDS dan memerlukan autentikasi terhadap server yang memproduksinya.
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.
Contoh
Contoh 1: Membaca dan mengurai file sqlaudit. Setiap objek yang dikembalikan akan berisi semua informasi dari satu catatan audit.
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 : {}
# ...
Contoh 2: Membaca dan mengurai streaming langsung XEvents dari SQL Server yang berjalan pada komputer yang sama yang terhubung dengan autentikasi Windows. Setiap objek yang dikembalikan akan berisi semua informasi dari satu rekaman 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 : {}
# ...
Parameter
-ConnectionString
String koneksi SQL Server.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
ByLiveData
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-FileName
Nama file file XEvent untuk dibaca.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
ByFile
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-SessionName
Nama sesi SQL Server XEvent sebagaimana didefinisikan oleh CREATE EVENT SESSION Transact-SQL.
Properti parameter
| Jenis: | String |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
ByLiveData
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.