ProxyAccount-Klasse

The ProxyAccount class represents a SQL Server Agent proxy account.

Vererbungshierarchie

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent.ProxyAccount

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

Syntax

'Declaration
Public NotInheritable Class ProxyAccount _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Usage
Dim instance As ProxyAccount

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

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

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

public final class ProxyAccount extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

Der ProxyAccount-Typ macht folgende Elemente verfügbar.

Konstruktoren

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

Zum Anfang

Eigenschaften

	Name	Beschreibung
	CredentialID	Gets the ID value that uniquely identifies the proxy agent credential.
	CredentialIdentity	Gets the credential identity.
	CredentialName	Gets or sets the name of the credential.
	Description	Gets or sets a textual description of the proxy account.
	ID	Gets the ID value that uniquely identifies the proxy account.
	IsEnabled	Gets or sets the Boolean property value that specifies whether the proxy account is enabled or not.
	Name	Gets or sets the name of the object. (Geerbt von NamedSmoObject.)
	Parent	Gets or sets the JobServer object that is the parent of the ProxyAccount object.
	Properties	Gets a collection of Property objects that represent the object properties. (Geerbt von SqlSmoObject.)
	State	Gets the state of the referenced object. (Geerbt von SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Geerbt von SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Geerbt von SmoObjectBase.)

Zum Anfang

Methoden

	Name	Beschreibung
	AddLogin	Adds a Microsoft Windows login account to the proxy account.
	AddMsdbRole	Adds a Microsoft SQL Server database role to the proxy account.
	AddServerRole	Adds a Microsoft SQL Server server role to the proxy account.
	AddSubSystem	Adds a Microsoft SQL Server subsystem to the proxy account.
	Alter	Updates any ProxyAccount object property changes on an instance of Microsoft SQL Server.
	Create	Creates a job on the instance of Microsoft SQL Server as defined by the ProxyAccount object.
	Discover	Discovers a list of type Object. (Geerbt von SqlSmoObject.)
	Drop	Removes an existing proxy account.
	EnumLogins	Enumerates a list of Microsoft Windows login accounts associated with the referenced proxy account.
	EnumMsdbRoles	Enumerates a list of Microsoft SQL Server database roles associated with the referenced proxy account.
	EnumServerRoles	Enumerates a list of Microsoft SQL Server server roles associated with the referenced proxy account.
	EnumSubSystems	Enumerates a list of Microsoft SQL Server subsystems associated with the referenced proxy account.
	Equals	(Geerbt von Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Geerbt von SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Geerbt von SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Geerbt von AgentObjectBase.)
	GetHashCode	(Geerbt von Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetType	(Geerbt von Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Geerbt von SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Geerbt von SqlSmoObject.)
	Reassign	Reassign the job steps that refer to the current proxy account name to a new proxy account name.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Geerbt von SqlSmoObject.)
	RemoveLogin	Removes a Microsoft Windows login account from the referenced proxy account.
	RemoveMsdbRole	Removes a Microsoft SQL Server database role from the referenced proxy account.
	RemoveServerRole	Removes a Microsoft SQL Server server role from the referenced proxy account.
	RemoveSubSystem	Removes a Microsoft SQL Server subsystem from the referenced proxy account.
	Rename	Renames a proxy account.
	Script()	Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account.
	Script(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.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Geerbt von SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Geerbt von SqlSmoObject.)
	Validate	Validates the state of an object. (Geerbt von SmoObjectBase.)

Zum Anfang

Ereignisse

	Name	Beschreibung
	PropertyChanged	Represents the event that occurs when a property is changed. (Geerbt von SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Geerbt von SqlSmoObject.)

Zum Anfang

Explizite Schnittstellenimplementierungen

	Name	Beschreibung
	IAlienObject.Discover	Discovers any dependencies. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Geerbt von SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Geerbt von SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Geerbt von SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Geerbt von SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Geerbt von SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Geerbt von SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Geerbt von SqlSmoObject.)

Zum Anfang

Hinweise

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

Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Beispiele

Planen von automatischen, administrativen Tasks im SQL Server-Agent

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Management.Smo.Agent-Namespace

Andere Ressourcen

Planen von automatischen, administrativen Tasks im SQL Server-Agent

Automatisierte Administrationstasks (SQL Server-Agent)

sp_add_proxy (Transact-SQL)

sp_grant_proxy_to_subsystem (Transact-SQL)