sp_syspolicy_rename_policy (Transact-SQL)

Renames an existing policy in Policy-Based Management.

Topic link icon Transact-SQL Syntax Conventions

sp_syspolicy_rename_policy { [ @name = ] 'name' | [ @policy_id = ] policy_id }
    , [ @new_name = ] 'new_name'

[ @name= ] 'name'

Is the name of the policy that you want to rename. name is sysname, and must be specified if policy_id is NULL.

[ @policy_id= ] policy_id

Is the identifier for the policy that you want to rename. policy_id is int, and must be specified if name is NULL.

[ @new_name= ] 'new_name'

Is the new name for the policy. new_name is sysname, and is required. Cannot be NULL or an empty string.

0 (success) or 1 (failure)

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

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

Requires membership in the PolicyAdministratorRole fixed database role.

Security noteSecurity 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.

The following example renames a policy that is named 'Test Policy 1' to 'Test Policy 2'.

EXEC msdb.dbo.sp_syspolicy_rename_policy @name = N'Test Policy 1'
, @new_name = N'Test Policy 2';