Edit

Share via

sp_xp_cmdshell_proxy_account (Transact-SQL)

  • Article

Applies to: SQL Server Azure SQL Database

Creates a proxy credential for xp_cmdshell.

Note

xp_cmdshell is disabled by default. To enable xp_cmdshell, see xp_cmdshell (server configuration option).

Transact-SQL syntax conventions

Syntax

syntaxsql 
sp_xp_cmdshell_proxy_account [ NULL | { 'account_name' , 'password' } ]
[ ; ]

Arguments

NULL

Specifies that the proxy credential should be deleted.

'account_name'

Specifies the Windows account to be the proxy.

'password'

Specifies the password of the Windows account.

Return code values

0 (success) or 1 (failure).

Remarks

The proxy credential is called ##xp_cmdshell_proxy_account##.

When it's executed using the NULL option, sp_xp_cmdshell_proxy_account deletes the proxy credential.

Permissions

Requires CONTROL SERVER permission.

Examples

A. Create the proxy credential

The following example shows how to create a proxy credential for a Windows account called ADVWKS\Max04 with password ds35efg##65.

SQL 
EXEC sp_xp_cmdshell_proxy_account 'ADVWKS\Max04', 'ds35efg##65';
GO

B. Drop the proxy credential

The following example removes the proxy credential from the credential store.

SQL 
EXEC sp_xp_cmdshell_proxy_account NULL;
GO

Related content