Export (0) Print
Expand All

ProxyAccount Class

 

Applies To: SQL Server 2016 Preview

The ProxyAccount class represents a SQL Server Agent proxy account.

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


public sealed class ProxyAccount : AgentObjectBase, IAlterable, 
	ICreatable, IDroppable, IRenamable, IScriptable

NameDescription
System_CAPS_pubmethodProxyAccount()

Initializes a new instance of the ProxyAccount class.

System_CAPS_pubmethodProxyAccount(JobServer, String)

Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service, with the specified name.

System_CAPS_pubmethodProxyAccount(JobServer, String, String)

Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential.

System_CAPS_pubmethodProxyAccount(JobServer, String, String, Boolean)

Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential. It also specifies whether the proxy account is enabled.

System_CAPS_pubmethodProxyAccount(JobServer, String, String, Boolean, String)

Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential. It also specifies whether the proxy account is enabled.

NameDescription
System_CAPS_pubpropertyCredentialID

Gets the ID value that uniquely identifies the proxy agent credential.

System_CAPS_pubpropertyCredentialIdentity

Gets the credential identity.

System_CAPS_pubpropertyCredentialName

Gets or sets the name of the credential.

System_CAPS_pubpropertyDescription

Gets or sets a textual description of the proxy account.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the proxy account.

System_CAPS_pubpropertyIsEnabled

Gets or sets the Boolean property value that specifies whether the proxy account is enabled or not.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyParent

Gets or sets the JobServer object that is the parent of the ProxyAccount object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAddLogin(String)

Adds a Microsoft Windows login account to the proxy account.

System_CAPS_pubmethodAddMsdbRole(String)

Adds a Microsoft SQL Server database role to the proxy account.

System_CAPS_pubmethodAddServerRole(String)

Adds a Microsoft SQL Server server role to the proxy account.

System_CAPS_pubmethodAddSubSystem(AgentSubSystem)

Adds a Microsoft SQL Server subsystem to the proxy account.

System_CAPS_pubmethodAlter()

Updates any ProxyAccount object property changes on an instance of Microsoft SQL Server.

System_CAPS_pubmethodCreate()

Creates a job on the instance of Microsoft SQL Server as defined by the ProxyAccount object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes an existing proxy account.

System_CAPS_pubmethodEnumLogins()

Enumerates a list of Microsoft Windows login accounts associated with the referenced proxy account.

System_CAPS_pubmethodEnumMsdbRoles()

Enumerates a list of Microsoft SQL Server database roles associated with the referenced proxy account.

System_CAPS_pubmethodEnumServerRoles()

Enumerates a list of Microsoft SQL Server server roles associated with the referenced proxy account.

System_CAPS_pubmethodEnumSubSystems()

Enumerates a list of Microsoft SQL Server subsystems associated with the referenced proxy account.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from AgentObjectBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodReassign(String)

Reassign the job steps that refer to the current proxy account name to a new proxy account name.

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRemoveLogin(String)

Removes a Microsoft Windows login account from the referenced proxy account.

System_CAPS_pubmethodRemoveMsdbRole(String)

Removes a Microsoft SQL Server database role from the referenced proxy account.

System_CAPS_pubmethodRemoveServerRole(String)

Removes a Microsoft SQL Server server role from the referenced proxy account.

System_CAPS_pubmethodRemoveSubSystem(AgentSubSystem)

Removes a Microsoft SQL Server subsystem from the referenced proxy account.

System_CAPS_pubmethodRename(String)

Renames a proxy account.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account as specified by the scripting options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

Proxy accounts allow for the impersonation of logins, server roles, and database roles when executing a job step in any subsystem other than Transact-SQL. In SQL Server Management Objects (SMO), the ProxyAccount object allows programmatic control over proxy accounts. The ProxyAccount object describes the relationship between an alternative (proxy) login account, a subsystem that is used for job step execution, and a list of Microsoft SQL Server logins, server roles, and database roles.

To get ProxyAccount object properties, users must be a member of the SQLAgentOperatorRole on the MSDB database, or be a member of the sysadmin fixed server role.

To set ProxyAccount object properties, users must be a member of the sysadmin fixed server role.

To create or drop a proxy account, users must be a member of the sysadmin fixed server role.

To add or remove subsystems from the proxy account, users must be a member of the sysadmin fixed server role.

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

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

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft