sp_syspolicy_rename_policy_category (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Renames an existing policy category in Policy-Based Management.

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_syspolicy_rename_policy_category { [ @name = ] 'name' | [ @policy_category_id = ] policy_category_id }  
    , [ @new_name = ] 'new_name'  

Arguments

[ @name = ] 'name'
Is the name of the policy category that you want to rename. name is sysname, and must be specified if policy_category_id is NULL.

[ @policy_category_id= ] policy_category_id
Is the identifier for the policy category that you want to rename. policy_category_id is int, and must be specified if name is NULL.

[ @new_name= ] 'new_name'
Is the new name for the policy category. new_name is sysname, and is required. Cannot be NULL or an empty string.

Return Code Values

0 (success) or 1 (failure)

Remarks

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

You must specify a value for either name or policy_category_id. Both cannot be NULL. To obtain these values, query the msdb.dbo.syspolicy_policy_categories system view.

Permissions

Requires membership in the PolicyAdministratorRole fixed database role.

Important

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 renames a policy category that is named 'Test Category 1' to 'Test Category 2'.

EXEC msdb.dbo.sp_syspolicy_rename_policy_category @name = N'Test Category 1'  
, @new_name = N'Test Category 2';  

GO  

See Also

Policy-Based Management Stored Procedures (Transact-SQL)
sp_syspolicy_add_policy_category (Transact-SQL)
sp_syspolicy_delete_policy_category (Transact-SQL)
sp_syspolicy_update_policy_category (Transact-SQL)