sp_add_category (Transact-SQL)
Applies to: SQL Server Azure SQL Managed Instance
Adds the specified category of jobs, alerts, or operators to the server. For alternative method, see Create Job Category using SQL Server Management Studio.
Transact-SQL syntax conventions
Important
On Azure SQL Managed Instance, most, but not all SQL Server Agent features are currently supported. See Azure SQL Managed Instance T-SQL differences from SQL Server for details.
Syntax
sp_add_category
[ [ @class = ] 'class' ]
[ , [ @type = ] 'type' ]
[ , [ @name = ] 'name' ]
[ ; ]
Arguments
[ @class = ] 'class'
The class of the category to be added. @class is varchar(8) with a default value of JOB
, and can be one of these values.
Value | Description |
---|---|
JOB |
Adds a job category. |
ALERT |
Adds an alert category. |
OPERATOR |
Adds an operator category. |
[ @type = ] 'type'
The type of category to be added. @type is varchar(12), with a default value of LOCAL
, and can be one of these values.
Value | Description |
---|---|
LOCAL |
A local job category. |
MULTI-SERVER |
A multiserver job category. |
NONE |
A category for a class other than JOB . |
[ @name = ] 'name'
The name of the category to be added. The name must be unique within the specified class. @name is sysname, with no default.
Return code values
0
(success) or 1
(failure).
Result set
None.
Remarks
sp_add_category
must be run from the msdb
database.
Permissions
This stored procedure is owned by the db_owner role. You can grant EXECUTE
permissions for any user, but these permissions may be overridden during a SQL Server upgrade.
Examples
The following example creates a local job category named AdminJobs
.
USE msdb;
GO
EXEC dbo.sp_add_category
@class = N'JOB',
@type = N'LOCAL',
@name = N'AdminJobs';
GO
Related content
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for