sp_grant_proxy_to_subsystem (Transact-SQL)

 

Grants a proxy access to a subsystem.

Applies to: SQL Server (SQL Server 2008 through current version).

Topic link icon Transact-SQL Syntax Conventions

  
sp_grant_proxy_to_subsystem  
     { [ @proxy_id = ] proxy_id | [ @proxy_name = ] 'proxy_name' },  
     { [ @subsystem_id = ] subsystem_id | [ @subsystem_name = ] 'subsystem_name' }  

[ @proxy_id = ] id
The proxy identification number of the proxy to grant access for. The proxy_id is int, with a default of NULL. Either proxy_id or proxy_name must be specified, but both cannot be specified.

[ @proxy_name = ] 'proxy_name'
The name of the proxy to grant access for. The proxy_name is sysname, with a default of NULL. Either proxy_id or proxy_name must be specified, but both cannot be specified.

[ @subsystem_id = ] id
The id number of the subsystem to grant access to. The subsystem_id is int, with a default of NULL. Either subsystem_id or subsystem_name must be specified, but both cannot be specified. The following table lists the values for each subsystem.

ValueDescription
2Microsoft ActiveX Script

 ** Important ** The ActiveX Scripting subsystem will be removed from SQL Server Agent in a future version of MicrosoftSQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
3Operating System (CmdExec)
4Replication Snapshot Agent
5Replication Log Reader Agent
6Replication Distribution Agent
7Replication Merge Agent
8Replication Queue Reader Agent
9Analysis Services Query
10Analysis Services Command
11SSIS package execution
12PowerShell Script

[ @subsystem_name = ] 'subsystem_name'
The name of the subsystem to grant access to. The subsystem_name is sysname, with a default of NULL. Either subsystem_id or subsystem_name must be specified, but both cannot be specified. The following table lists the values for each subsystem.

ValueDescription
ActiveScriptingActiveX Script
CmdExecOperating System (CmdExec)
SnapshotReplication Snapshot Agent
LogReaderReplication Log Reader Agent
DistributionReplication Distribution Agent
MergeReplication Merge Agent
QueueReaderReplication Queue Reader Agent
ANALYSISQUERYAnalysis Services Query
ANALYSISCOMMANDAnalysis Services Command
DtsSSIS package execution
PowerShellPowerShell Script

Granting a proxy access to a subsystem does not change the permissions for the principal specified in the proxy.

Only members of the sysadmin fixed server role can execute sp_grant_proxy_to_subsystem.

A. Granting access to a subsystem by ID

The following example grants the proxy Catalog application proxy access to the ActiveX Scripting subsystem.

USE msdb ;  
GO  
  
EXEC dbo.sp_grant_proxy_to_subsystem  
    @proxy_name = 'Catalog application proxy',  
    @subsystem_id = 2;  
GO  

B. Granting access to a subsystem by name.

The following example grants the proxy Catalog application proxy access to the SSIS package execution subsystem.

USE msdb ;  
GO  
  
EXEC dbo.sp_grant_proxy_to_subsystem  
    @proxy_name = N'Catalog application proxy',  
    @subsystem_name = N'Dts' ;  
GO  

Implement SQL Server Agent Security
sp_revoke_proxy_from_subsystem (Transact-SQL)
sp_add_proxy (Transact-SQL)
sp_delete_proxy (Transact-SQL)
sp_update_proxy (Transact-SQL)

Community Additions

ADD
Show: