Article
10/01/2010

sp_syspolicy_add_policy_category (Transact-SQL)

Adds a policy category that can be used with Policy-Based Management. Policy categories enable you to organize policies, and to set policy scope.

Topic link icon Transact-SQL Syntax Conventions

Syntax

sp_syspolicy_add_policy_category [ @name= ] 'name'
    [ , [ @mandate_database_subscriptions= ] mandate_database_subscriptions ]
    , [ @policy_category_id= ] policy_category_id OUTPUT

Arguments

[ @name= ] 'name'
Is the name of the policy category. name is sysname, and is required. name cannot be NULL or an empty string.
[ @mandate_database_subscriptions = ] mandate_database_subscriptions
Determines whether database subscription is mandated for the policy category. mandate_database_subscriptions is a bit value, with a default of 1 (enabled).
[ @policy_category_id= ] policy_category_id
Is the identifier for the policy category. policy_category_id is int, and is returned as OUTPUT.

Return Code Values

0 (success) or 1 (failure)

Remarks

You must run sp_syspolicy_add_policy_category in the context of the msdb system database.

Permissions

Requires membership in the PolicyAdministratorRole fixed database role.

Security Note
Possible elevation of credentials: Users in the PolicyAdministratorRole role can create server triggers and schedule policy executions that can affect the operation of the instance of the Database Engine. For example, users in the PolicyAdministratorRole role can create a policy that can prevent most objects from being created in the Database Engine. Because of this possible elevation of credentials, the PolicyAdministratorRole role should be granted only to users who are trusted with controlling the configuration of the Database Engine.

Possible elevation of credentials: Users in the PolicyAdministratorRole role can create server triggers and schedule policy executions that can affect the operation of the instance of the Database Engine. For example, users in the PolicyAdministratorRole role can create a policy that can prevent most objects from being created in the Database Engine. Because of this possible elevation of credentials, the PolicyAdministratorRole role should be granted only to users who are trusted with controlling the configuration of the Database Engine.

Examples

The following example creates a policy category where subscription to the category is not mandated. This means that individual databases can be configured to opt in or opt out of policies in the category.

DECLARE @policy_category_id int;

EXEC msdb.dbo.sp_syspolicy_add_policy_category
  @name = N'Table Naming Policies'
, @mandate_database_subscriptions = 0
, @policy_category_id = @policy_category_id OUTPUT;

GO

Share via