Skip to content

sp-syspolicy-add-policy-category-transact-sql.md

Latest commit

 

History

History
83 lines (58 loc) · 2.83 KB

sp-syspolicy-add-policy-category-transact-sql.md

File metadata and controls

83 lines (58 loc) · 2.83 KB
title sp_syspolicy_add_policy_category (Transact-SQL)
description Adds a policy category that can be used with Policy-Based Management.
author VanMSFT
ms.author vanto
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
sp_syspolicy_add_policy_category
sp_syspolicy_add_policy_category_TSQL
helpviewer_keywords
sp_syspolicy_add_policy_category
dev_langs
TSQL

sp_syspolicy_add_policy_category (Transact-SQL)

[!INCLUDE SQL Server]

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

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

Arguments

[ @name = ] N'name'

The name of the policy category. @name is sysname, and is required. @name can't 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 bit value, with a default of 1 (enabled).

[ @policy_category_id = ] policy_category_id

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.

[!INCLUDE policy-administrator-role]

Examples

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

DECLARE @policy_category_id AS INT;

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

Related content