Read-SqlXEvent
Lê SQL Server XEvents do arquivo XEL ou da sessão XEvent do SQL ao vivo.
Syntax
Read-SqlXEvent
[-FileName] <String>
[<CommonParameters>] Read-SqlXEvent
-ConnectionString <String>
-SessionName <String>
[<CommonParameters>] Description
O Read-SqlXEvent lê SQL Server XEvents de um arquivo ou de uma sessão XEvent do SQL ao vivo. As sessões XEvent são criadas pela API Transact-SQL CREATE EVENT SESSION. Os arquivos XEvent do SQL geralmente têm o . Extensões XEL ou .sqlaudit e contêm um fluxo de XEvents. A estrutura do XEvents é definida na configuração da sessão. As transmissões ao vivo do SQL estão disponíveis por meio do protocolo TDS do SQL e exigem autenticação no servidor que as produziu.
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.
Exemplos
Exemplo 1: ler e analisar o arquivo sqlaudit. Cada objeto retornado conterá todas as informações de um único registro de auditoria.
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 : {}
# ...Exemplo 2: ler e analisar a transmissão ao vivo de XEvents do SQL Server em execução no mesmo computador conectado ao autenticação do Windows. Cada objeto retornado conterá todas as informações de um único registro 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 : {}
# ...Parâmetros
-ConnectionString
SQL Server cadeia de conexão.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FileName
Nome de arquivo de um arquivo XEvent a ser lido.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SessionName
O SQL Server nome da sessão XEvent conforme definido pelo Transact-SQL CREATE EVENT SESSION.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Entradas
System.String
Saídas
Microsoft.SqlServer.XEvent.XELite.IXEvent