Partager via


Classe ProxyAccount

The ProxyAccount class represents a SQL Server Agent proxy account.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo.Agent
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class ProxyAccount _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Utilisation
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

Le type ProxyAccount expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique ProxyAccount() Initializes a new instance of the ProxyAccount class.
Méthode publique ProxyAccount(JobServer, String) Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service, with the specified name.
Méthode publique 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.
Méthode publique 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.
Méthode publique 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.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

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

Haut de la page

Événements

  Nom Description
Événement public PropertyChanged Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
Événement public PropertyMetadataChanged Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée IAlienObject.Discover Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetDomainRoot Returns the root of the domain. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetParent Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyType Gets the type of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyValue Gets the value of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetPropertyValue Sets the property value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)

Haut de la page

Notes

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

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Exemples

Planification des tâches administratives automatiques dans l'Agent SQL Server

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo.Agent

Autres ressources

Planification des tâches administratives automatiques dans l'Agent SQL Server

Tâches d'administration automatisée (Agent SQL Server)

sp_add_proxy (Transact-SQL)

sp_grant_proxy_to_subsystem (Transact-SQL)