sp_update_proxy (Transact-SQL)

适用于:SQL Server (所有受支持的版本)

更改现有代理的属性。

主题链接图标Transact-SQL 语法约定

语法

  
sp_update_proxy   
    [ @proxy_id = ] id,  
    [ @proxy_name = ] 'proxy_name',  
    [ @credential_name = ] 'credential_name' ,  
    [ @credential_id = ] credential_id ,  
    [ @new_name = ] 'new_name' ,  
    [ @enabled = ] is_enabled ,  
    [ @description = ] 'description'  

参数

[ @proxy_id = ] id 要更改的代理的代理标识号。 proxy_idint,默认值为 NULL。

[ @proxy_name = ] 'proxy_name' 要更改的代理的名称。 proxy_namesysname,默认值为 NULL。

[ @credential_name = ] 'credential_name' 代理的新凭据的名称。 credential_namesysname,默认值为 NULL。 可以指定 credential_namecredential_id

[ @credential_id = ] credential_id 代理的新凭据的标识号。 credential_idint,默认值为 NULL。 可以指定 credential_namecredential_id

[ @new_name = ] 'new_name' 代理的新名称。 new_namesysname,默认值为 NULL。 提供后,该过程会将代理的名称更改为 new_name。 当此参数为 NULL 时,代理名称保持不变。

[ @enabled = ] is_enabled 是否启用代理。 is_enabled标志为 tinyint,默认值为 NULL。 当is_enabled为 0 时,代理未启用,并且无法由作业步骤使用。 当此参数为 NULL 时,代理的状态保持不变。

[ @description = ] 'description' 代理的新说明。 说明nvarchar (512) ,默认值为 NULL。 当此参数为 NULL 时,代理的说明保持不变。

返回代码值

0 (成功) 或 1 (失败)

备注

必须指定 @proxy_name@proxy_id 。 如果同时指定这两个参数,这两个参数必须引用相同的代理,否则存储过程会失败。

必须指定 @credential_name@credential_id 才能更改代理的凭据。 如果两个参数均被指定,则它们必须引用相同的凭据,否则存储过程将失败。

此过程将更改代理,但不更改对代理的访问权限。 若要更改对代理的访问权限,请使用 sp_grant_login_to_proxysp_revoke_login_from_proxy

权限

只有 sysadmin 固定安全角色的成员才能执行此过程。

示例

以下示例将代理 Catalog application proxy 的 enabled 值设置为 0

USE msdb ;  
GO  
  
EXEC dbo.sp_update_proxy  
    @proxy_name = 'Catalog application proxy',  
    @enabled = 0;  
GO  

另请参阅

SQL Server 代理存储过程 (Transact-SQL)
实现 SQL Server 代理安全性
sp_add_proxy (Transact-SQL)
sp_delete_proxy (Transact-SQL)
sp_grant_login_to_proxy (Transact-SQL)
sp_revoke_login_from_proxy (Transact-SQL)