Export (0) Print
Expand All

ProxyAccount Class

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)

[<SealedAttribute>]
type ProxyAccount =  
    class 
        inherit AgentObjectBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
    end

The ProxyAccount type exposes the following members.

  NameDescription
Public methodProxyAccount()Initializes a new instance of the ProxyAccount class.
Public methodProxyAccount(JobServer, String)Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service, with the specified name.
Public methodProxyAccount(JobServer, String, String)Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential.
Public methodProxyAccount(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.
Public methodProxyAccount(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.
Top

  NameDescription
Public propertyCredentialIDGets the ID value that uniquely identifies the proxy agent credential.
Public propertyCredentialIdentityGets the credential identity.
Public propertyCredentialNameGets or sets the name of the credential.
Public propertyDescriptionGets or sets a textual description of the proxy account.
Public propertyIDGets the ID value that uniquely identifies the proxy account.
Public propertyIsEnabledGets or sets the Boolean property value that specifies whether the proxy account is enabled or not.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyParentGets or sets the JobServer object that is the parent of the ProxyAccount object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAddLoginAdds a Microsoft Windows login account to the proxy account.
Public methodAddMsdbRoleAdds a Microsoft SQL Server database role to the proxy account.
Public methodAddServerRoleAdds a Microsoft SQL Server server role to the proxy account.
Public methodAddSubSystemAdds a Microsoft SQL Server subsystem to the proxy account.
Public methodAlterUpdates any ProxyAccount object property changes on an instance of Microsoft SQL Server.
Public methodCreateCreates a job on the instance of Microsoft SQL Server as defined by the ProxyAccount object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves an existing proxy account.
Public methodEnumLoginsEnumerates a list of Microsoft Windows login accounts associated with the referenced proxy account.
Public methodEnumMsdbRolesEnumerates a list of Microsoft SQL Server database roles associated with the referenced proxy account.
Public methodEnumServerRolesEnumerates a list of Microsoft SQL Server server roles associated with the referenced proxy account.
Public methodEnumSubSystemsEnumerates a list of Microsoft SQL Server subsystems associated with the referenced proxy account.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodReassignReassign the job steps that refer to the current proxy account name to a new proxy account name.
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemoveLoginRemoves a Microsoft Windows login account from the referenced proxy account.
Public methodRemoveMsdbRoleRemoves a Microsoft SQL Server database role from the referenced proxy account.
Public methodRemoveServerRoleRemoves a Microsoft SQL Server server role from the referenced proxy account.
Public methodRemoveSubSystemRemoves a Microsoft SQL Server subsystem from the referenced proxy account.
Public methodRenameRenames a proxy account.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account.
Public methodScript(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.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Thread Safety

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.

Community Additions

ADD
Show:
© 2014 Microsoft