Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 3.05 KB

File metadata and controls

74 lines (54 loc) · 3.05 KB
title sp_syspolicy_rename_policy (Transact-SQL) | Microsoft Docs
ms.custom
ms.date 08/09/2016
ms.prod sql
ms.prod_service database-engine
ms.reviewer
ms.technology system-objects
ms.topic language-reference
f1_keywords
sp_syspolicy_rename_policy_TSQL
sp_syspolicy_rename_policy
dev_langs
TSQL
helpviewer_keywords
sp_syspolicy_rename_policy
ms.assetid ce2b07f5-23b1-4f49-8e7b-c18cf3f3d45b
author VanMSFT
ms.author vanto

sp_syspolicy_rename_policy (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx-md]

Renames an existing policy in Policy-Based Management.

Topic link icon Transact-SQL Syntax Conventions

Syntax

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

Arguments

[ @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.

Return Code Values

0 (success) or 1 (failure)

Remarks

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.

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 [!INCLUDEssDE]. For example, users in the PolicyAdministratorRole role can create a policy that can prevent most objects from being created in the [!INCLUDEssDE]. 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 [!INCLUDEssDE].

Examples

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';  
  
GO  

See Also

Policy-Based Management Stored Procedures (Transact-SQL)