Get the Configurable Parameters for the ADD TARGET Argument

  • Article

Accomplishing this task involves using Query Editor in SQL Server Management Studio.

After the statements in this procedure finish, the Results tab of Query Editor displays the following columns:

  • package_name

  • target_name

  • parameter_name

  • parameter_type

  • required

Before You Begin

Before you create a SQL Server Extended Events session, it is useful to find out what parameters you can set when you use the ADD TARGET argument in CREATE EVENT SESSION or ALTER EVENT SESSION.

To get the configurable parameters for the ADD TARGET argument using Query Editor

  • In Query Editor, issue the following statements.

    SELECT p.name package_name, o.name target_name, c.name parameter_name, 
c.type_name parameter_type, CASE c.capabilities_desc WHEN 'mandatory' THEN 'yes' ELSE 'no' END 
required 
FROM sys.dm_xe_objects o JOIN sys.dm_xe_packages p ON o.package_guid = p.guid 
JOIN sys.dm_xe_object_columns c ON o.name = c.object_name AND c.column_type = 'customizable'
WHERE o.object_type = 'target' 
ORDER BY package_name, target_name, required DESC

See Also

Reference

CREATE EVENT SESSION (Transact-SQL)

ALTER EVENT SESSION (Transact-SQL)

sys.dm_xe_objects (Transact-SQL)

sys.dm_xe_packages (Transact-SQL)