OperatorCategories Collection

SQL-DMO

SQL-DMO

OperatorCategories Collection

The OperatorCategories collection contains Category objects that reference a classification method for SQL Server Agent operators.

Properties
Count Property  
Methods
Add Method Refresh Method
Item Method Remove Method (Collections)
ItemByID Method  

Remarks

For SQL Server Agent, categories offer a mixed system and user-defined method for grouping alerts, operators, and jobs.

With the OperatorCategories collection, you can:

  • Create a new classification for SQL Server Agent operators.

  • Remove a SQL Server Agent operator classification.

For more information about creating a SQL Server Agent operator category, see Category Object.

To remove an operator category

  • Use the Remove method of the OperatorCategories collection, as in:
    oJobServer.OperatorCategories.Remove("Page")

Note  When using the Remove method of the OperatorCategories collection, existing SQL Server Agent jobs are reclassified as necessary. Any operators previously exhibiting the removed category exhibit the category [Uncategorized] after the Remove method completes.

When using the Item or Remove method, the OperatorCategories collection supports member identification using either name or ordinal reference syntax. For example:

Set oCategory = oJobServer.OperatorCategories("Page")

Or:

Set oCategory = oJobServer.OperatorCategories(1)