sp_grant_login_to_proxy (Transact-SQL)
Applies to:
SQL Server
Grants a security principal access to a proxy.
Transact-SQL syntax conventions
Syntax
sp_grant_login_to_proxy
[ [ @login_name = ] N'login_name' ]
[ , [ @fixed_server_role = ] N'fixed_server_role' ]
[ , [ @msdb_role = ] N'msdb_role' ]
[ , [ @proxy_id = ] proxy_id ]
[ , [ @proxy_name = ] N'proxy_name' ]
[ ; ]
Arguments
[ @login_name = ] N'login_name'
The login name to grant access to. @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 = ] N'fixed_server_role'
The fixed server role to grant access to. @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 = ] N'msdb_role'
The database role in the msdb
database to grant access to. @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 = ] proxy_id
The identifier for the proxy to grant access for. @proxy_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 = ] N'proxy_name'
The name of the proxy to grant access for. @proxy_name is sysname, 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
This stored procedure is owned by the db_owner role. You can grant EXECUTE
permissions for any user, but these permissions may be overridden during a SQL Server upgrade.
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