ServerProxyAccount Class

Article
08/11/2014

The ServerProxyAccount class represents the implementation of a proxy account on an instance of SQL Server. The ProxyAccount object allows for impersonation of job step execution. Created by the system administrator, it can be further be assigned to a login or a server role or a database role and one of the subsystems, except for Transact-SQL.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.ServerProxyAccount

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class ServerProxyAccount _
    Inherits SqlSmoObject _
    Implements IAlterable
'Usage
Dim instance As ServerProxyAccount

public sealed class ServerProxyAccount : SqlSmoObject, 
    IAlterable

public ref class ServerProxyAccount sealed : public SqlSmoObject, 
    IAlterable

[<SealedAttribute>]
type ServerProxyAccount =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
    end

public final class ServerProxyAccount extends SqlSmoObject implements IAlterable

The ServerProxyAccount type exposes the following members.

Properties

	Name	Description
	IsEnabled	Gets or sets the Boolean property value that specifies whether the proxy account is enabled on the instance of SQL Server.
	Parent	Gets the Server object that is the parent of the ServerProxyAccount object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	WindowsAccount	Gets the proxy account name.

Top

Methods

	Name	Description
	Alter	Updates any ServerProxyAccount object property changes on the instance of Microsoft SQL Server.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	SetAccount(String, SecureString)	Sets the account name and secure password for the proxy account on the instance of SQL Server.
	SetAccount(String, String)	Sets the account name and password for the proxy account on the instance of SQL Server.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetPassword(SecureString)	Sets the proxy account password to the specified secure string.
	SetPassword(String)	Sets the proxy account password to the specified string.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

With the ServerProxyAccount object you can:

Allow impersonation of job step execution.
Assign the proxy account to a login, server role, or database role.
Assign the proxy account to a subsystem (except Transact-SQL)

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via