sp_grant_login_to_proxy (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Grants a security principal access to a proxy.

Syntax

sp_grant_login_to_proxy   
     { [ @login_name = ] 'login_name'   
     | [ @fixed_server_role = ] 'fixed_server_role'   
     | [ @msdb_role = ] 'msdb_role' } ,   
     { [ @proxy_id = ] id | [ @proxy_name = ] 'proxy_name' }

Arguments

[ @login_name = ] 'login_name' The login name to grant access to. The login_name is nvarchar(256), with a default of NULL. One of @login_name, @fixed_server_role, or @msdb_role must be specified, or the stored procedure fails.

[ @fixed_server_role = ] 'fixed_server_role' The fixed server role to grant access to. The fixed_server_role is nvarchar(256), with a default of NULL. One of @login_name, @fixed_server_role, or @msdb_role must be specified, or the stored procedure fails.

[ @msdb_role = ] 'msdb_role' The database role in the msdb database to grant access to. The msdb_role is nvarchar(256), with a default of NULL. One of @login_name, @fixed_server_role, or @msdb_role must be specified, or the stored procedure fails.

[ @proxy_id = ] id The identifier for the proxy to grant access for. The id is int, with a default of NULL. One of @proxy_id or @proxy_name must be specified, or the stored procedure fails.

[ @proxy_name = ] 'proxy_name' The name of the proxy to grant access for. The proxy_name is nvarchar(256), with a default of NULL. One of @proxy_id or @proxy_name must be specified, or the stored procedure fails.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_grant_login_to_proxy must be run from the msdb database.

Permissions

Only members of the sysadmin fixed server role may execute sp_grant_login_to_proxy.

Examples

The following example allows the login adventure-works\terrid to use the proxy Catalog application proxy.

USE msdb ;  
GO  
  
EXEC dbo.sp_grant_login_to_proxy  
    @login_name = N'adventure-works\terrid',  
    @proxy_name = N'Catalog application proxy' ;  
GO