TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

sp_help_proxy (Transact-SQL)

 

Updated: August 9, 2016

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Lists information for one or more proxies.

Topic link icon Transact-SQL Syntax Conventions

  
sp_help_proxy   
    [ @proxy_id = ] id,  
    [ @proxy_name = ] 'proxy_name' ,  
    [ @subsystem_name = ] 'subsystem_name' ,  
    [ @name = ] 'name'  

[ @proxy_id = ] id
The proxy identification number of the proxy to list information for. The proxy_id is int, with a default of NULL. Either the id or the proxy_name may be specified.

[ @proxy_name = ] 'proxy_name'
The name of the proxy to list information for. The proxy_name is sysname, with a default of NULL. Either the id or the proxy_name may be specified.

[ @subsystem_name = ] 'subsystem_name'
The name of the subsystem to list proxies for. The subsystem_name is sysname, with a default of NULL. When subsystem_name is specified, name must also 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 Command
ANALYSISCOMMANDAnalysis Services Query
DtsSSIS package execution
PowerShellPowerShell Script

[ @name = ] 'name'
The name of a SQL Server login to list proxies for. The name is nvarchar(256), with a default of NULL. When name is specified, subsystem_name must also be specified.

0 (success) or 1 (failure)

Column nameData typeDescription
proxy_idintProxy identification number.
namesysnameThe name of the proxy.
credential_identitysysnameThe Microsoft Windows domain name and user name for the credential associated with the proxy.
enabledtinyintWhether this proxy is enabled. { 0 = not enabled, 1 = enabled }
descriptionnvarchar(1024)The description for this proxy.
user_sidvarbinary(85)The Windows security id of the Windows user for this proxy.
credential_idintThe identifier for the credential associated with this proxy.
credential_identity_existsintWhether the credential_identity exists. { 0 = does not exist, 1 = exists }

When no parameters are provided, sp_help_proxy lists information for all proxies in the instance.

To determine which proxies a login can use for a given subsystem, specify name and subsystem_name. When these arguments are provided, sp_help_proxy lists proxies that the login specified may access and that may be used for the specified subsystem.

By default, members of the sysadmin fixed server role can execute this stored procedure. Other users must be granted the SQLAgentOperatorRole fixed database role in the msdb database.

For details about SQLAgentOperatorRole, see SQL Server Agent Fixed Database Roles.

System_CAPS_ICON_note.jpg Note


The credential_identity and user_sid columns are only returned in the result set when members of sysadmin execute this stored procedure.

A. Listing information for all proxies

The following example lists information for all proxies in the instance.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_proxy ;  
GO  

B. Listing information for a specific proxy

The following example lists information for the proxy named Catalog application proxy.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_proxy  
    @proxy_name = N'Catalog application proxy' ;  
GO  

SQL Server Agent Stored Procedures (Transact-SQL)
sp_add_proxy (Transact-SQL)
sp_delete_proxy (Transact-SQL)

Community Additions

ADD
Show:
© 2016 Microsoft